<commit_before>Spree/ShipStation Integration
==============================

Integrates [ShipStation](http://www.shipstation.com) with [Spree](http://spreecommerce.com). It enables ShipStation to pull shipments from the system and update tracking numbers.

For documentation on API, see [doc/ShipStationCustomStoreDevGuide.pdf](https://github.com/DynamoMTL/spree_shipstation/blob/master/doc/ShipStationCustomStoreDevGuide.pdf)

Configuring
-----------

Add spree_shipstation to your Gemfile

```ruby
gem "spree_shipstation"
```

Alternatively

```ruby
gem "spree_shipstation", git: "git://github.com/DynamoMTL/spree_shipstation.git"
```

Run bundler

    $ bundle

Configure the ShipStation API username and password. This can be done in an initializer

```ruby
# config/initializers/shipstation.rb

if Rails.env.production?
  Spree::Config.shipstation_username = "brett"
  Spree::Config.shipstation_password = "<PASSWORD>"
else
  Spree::Config.shipstation_username = "jody"
  Spree::Config.shipstation_password = "<PASSWORD>"
end

Spree::Config.shipstation_weight_units = "Grams" # Grams, Ounces or Pounds
```


Testing
-------

Be sure to bundle your dependencies and then create a dummy test app for the specs to run against.

    $ bundle
    $ bundle exec rake test_app

To run tests:

    $ bundle exec rspec spec

To run tests with guard (preferred):
    
    $ bundle exec guard

Copyright (c) 2013 Dynamo, released under the New BSD License
<commit_msg>updates link to api doc to use raw format<commit_after>Spree/ShipStation Integration
==============================

Integrates [ShipStation](http://www.shipstation.com) with [Spree](http://spreecommerce.com). It enables ShipStation to pull shipments from the system and update tracking numbers.

For documentation on API, see [doc/ShipStationCustomStoreDevGuide.pdf](https://github.com/DynamoMTL/spree_shipstation/blob/master/doc/ShipStationCustomStoreDevGuide.pdf?raw=true)

Configuring
-----------

Add spree_shipstation to your Gemfile

```ruby
gem "spree_shipstation"
```

Alternatively

```ruby
gem "spree_shipstation", git: "git://github.com/DynamoMTL/spree_shipstation.git"
```

Run bundler

    $ bundle

Configure the ShipStation API username and password. This can be done in an initializer

```ruby
# config/initializers/shipstation.rb

if Rails.env.production?
  Spree::Config.shipstation_username = "brett"
  Spree::Config.shipstation_password = "<PASSWORD>"
else
  Spree::Config.shipstation_username = "jody"
  Spree::Config.shipstation_password = "<PASSWORD>"
end

Spree::Config.shipstation_weight_units = "Grams" # Grams, Ounces or Pounds
```


Testing
-------

Be sure to bundle your dependencies and then create a dummy test app for the specs to run against.

    $ bundle
    $ bundle exec rake test_app

To run tests:

    $ bundle exec rspec spec

To run tests with guard (preferred):
    
    $ bundle exec guard

Copyright (c) 2013 Dynamo, released under the New BSD License

{'fraction_non_alphanumeric': 0.12158054711246201, 'fraction_numerical': 0.002701789935832489, 'mean_word_length': 4.641904761904762, 'pattern_counts': {'":': 0, '<': 7, '<?xml version=': 0, '>': 7, 'https://': 2, 'lorem ipsum': 0, 'www.': 2, 'xml': 0}, 'pii_count': 0, 'substrings_counts': 0, 'word_list_counts': {'cursed_substrings.json': 0, 'profanity_word_list.json': 0, 'sexual_word_list.json': 0, 'zh_pornsignals.json': 0}}
{'dir': 'git-commits-cleaned', 'id': '6971064', 'n_tokens_mistral': 932, 'n_tokens_neox': 881, 'n_words': 264}