ship_station 0.0.2 → 0.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 18c0f3699a6970e2b4d037b9799f84b06e7e22d4
-  data.tar.gz: cc0bef5f68d5bd31a215eecae675c048c2f7cc75
+  metadata.gz: d541da1b8d5a90890bcaa731a0234eea3c76b15d
+  data.tar.gz: cea268522b3bd920af0eba90432829e1e8827cf8
 SHA512:
-  metadata.gz: 9e7205bcfa8e904e2288b855c83f15aade3eeb5d2a023577d74e90858eea41e09fc8818fd330e855b497d7ebd9604033a27fb20d832751e8f0ef8b8484f3441a
-  data.tar.gz: 818dc358fb109575178192fc2ecfab66de71108013cb5b3b6465e37bd38115ed43fd8731e43eb64b0784f1f1e1bc896f88b52a4cf68c6e1b23c2ec1fcff6d1c7
+  metadata.gz: ca7e489d5a5244c1ef29c7c592f7f9f461d2853ab235ba0927a12befd0910ffe11ea03e132e88b2fbf9030bdf43f3c6fb690a4e97934daea773595e54cd140a7
+  data.tar.gz: eb73d08ff8fdb0e2623c41bf5a258cc6198219083ce43715aeb252151b5e4118904e0e7943c395792b0df5719e13b12b9489f3c824896e4a72f9bf002c6f2439

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2018 Ben Jacobs
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,103 @@
+[![Version      ](https://img.shields.io/gem/v/ship_station.svg?maxAge=2592000)](https://rubygems.org/gems/ship_station)
+[![Build Status ](https://travis-ci.com/Benjaminpjacobs/ship_station.svg)](https://travis-ci.com/Benjaminpjacobs/ship_station)
+[![Maintainability](https://api.codeclimate.com/v1/badges/a1c730263b7724ae7002/maintainability)](https://codeclimate.com/github/Benjaminpjacobs/ship_station/maintainability)
+[![Test Coverage](https://api.codeclimate.com/v1/badges/a1c730263b7724ae7002/test_coverage)](https://codeclimate.com/github/Benjaminpjacobs/ship_station/test_coverage)
+## Shipstation
+
+Another Ruby wrapper for the ShipStation API.
+
+## Installation
+
+Add module to your Gemfile:
+
+```ruby
+gem 'ship_station'
+```
+
+Then run bundle to install the Gem:
+
+```sh
+bundle install
+```
+
+Set up your environment file with your Shipstation API key and secret:
+
+```
+SHIPSTATION_API_KEY: <YOUR SHIPSTATION KEY>
+SHIPSTATION_API_SECRET: <YOUR SHIPSTATION SECRET>
+```
+
+If using the gem without an environment file, you can initialize these manually.
+```ruby
+ShipStation.username = <YOUR SHIPSTATION KEY>
+ShipStation.password = <YOUR SHIPSTATION SECRET>
+```
+
+
+## Usage
+
+This gem provides a collection of operations for use within the Shipstation API.
+
+### List
+
+List all records for a resource.
+
+```ruby
+Shipstation::Carrier.all
+Shipstation::Customer.all
+Shipstation::FulFillment.all
+Shipstation::Order.all
+Shipstation::Product.all
+Shipstation::Shipment.all
+Shipstation::Store.all
+Shipstation::Warehouse.all
+```
+
+### Retrieve
+
+Retrieve a single record of a resource.
+
+```ruby
+Shipstation::Customer.find(customer_id)
+Shipstation::Customer.find(customer_id)
+Shipstation::Order.find(order_id)
+Shipstation::Product.find(product_id)
+Shipstation::Shipment.find(shipment_id)
+Shipstation::Store.find(store_id)
+Shipstation::Warehouse.find(warehouse_id)
+```
+
+### Pagination
+After making a request, pagination can be retreived off the collection.
+
+```ruby
+orders = Shipstation::Order.all
+orders.metadata[:page]  #=> 1
+orders.metadata[:pages] #=> 3
+orders.metadata[:total] #=> 250
+```
+
+### Rate Limiting
+
+After making a request, rate limit information(expressed as an integer of seconds) can be retreived off the module.
+
+```ruby
+orders = Shipstation::Order.all
+Shipstation.limit       #=> 40
+Shipstation.remaining   #=> 39
+Shipstation.reset_time  #=> 52
+
+```
+
+## How to contribute
+
+* Fork the project
+* Create your feature or bug fix
+* Add the requried tests for it.
+* Commit (do not change version or history)
+* Send a pull request against the *development* branch
+
+## Copyright
+Copyright (c) 2018 Ben Jacobs
+Licenced under the MIT licence.
+

data/lib/ship_station/api.rb

@@ -4,7 +4,7 @@ module ShipStation
     API.setup url: "https://ssapi.shipstation.com" do |c|
       #Authentication
       c.use Faraday::Request::BasicAuthentication, ShipStation.username, ShipStation.password
-      
+
       # Request
       c.use ShipStation::Middleware::JSONRequest
 

data/lib/ship_station/api/model.rb

@@ -4,7 +4,7 @@ module ShipStation
     include Her::Model
     use_api V1::API
     parse_root_in_json true, format: :active_model_serializers
-    
+
     def self.associated
       @associated ||= {}
     end

data/lib/ship_station/base.rb

@@ -16,14 +16,14 @@ module ShipStation
 
     def username
       @username ||= ENV["SHIPSTATION_API_KEY"] or
-      raise(ConfigurationError, "Shipstation username not configured")      
+      raise(ConfigurationError, "Shipstation username not configured")
     end
 
     def password
       @password ||= ENV["SHIPSTATION_API_SECRET"] or
       raise(ConfigurationError, "Shipstation password not configured")
     end
-      
+
   end
 end
 

data/lib/ship_station/middleware.rb

@@ -3,9 +3,9 @@ module ShipStation
     class ResponseParser < Her::Middleware::FirstLevelParseJSON
       def parse(env)
         json = parse_json(env)
-        
+
         return super unless json.is_a?(Hash)
-        
+
         errors = json.delete(:errors) || {}
         pagination = json.slice(:page, :pages, :total)
         {
@@ -14,12 +14,12 @@ module ShipStation
           :metadata => pagination
         }
       end
-      
+
       # This middleware gives the user access to rate limiting information
       def on_complete(env)
-        ShipStation.limit      = env.response.headers["x-rate-limit-limit"]
-        ShipStation.remaining  = env.response.headers["x-rate-limit-remaining"]
-        ShipStation.reset_time = env.response.headers["x-rate-limit-reset"]
+        ShipStation.limit      = env.response.headers["x-rate-limit-limit"].to_i
+        ShipStation.remaining  = env.response.headers["x-rate-limit-remaining"].to_i
+        ShipStation.reset_time = env.response.headers["x-rate-limit-reset"].to_i
         super(env)
       end
     end

data/lib/ship_station/version.rb

@@ -1,3 +1,3 @@
 module ShipStation
-  VERSION = "0.0.2"
+  VERSION = "0.0.3"
 end

data/spec/ship_station/base_spec.rb

@@ -13,25 +13,25 @@ RSpec.describe ShipStation do
 
   it "stores rate limiting information after each request" do
     stub_api_for(ShipStation::Order) do |stub|
-      stub.get("/orders") do |env| 
+      stub.get("/orders") do |env|
         [
-          200, 
+          200,
           {
             "x-rate-limit-limit" => 40,
             "x-rate-limit-remaining" => 39,
             "x-rate-limit-reset"=>20
-          }, 
+          },
           { orders: [{}],
             page: 1,
             pages: 1,
             total: 1
-          }.to_json 
+          }.to_json
         ]
-      end 
+      end
     end
-    
+
     ShipStation::Order.all.fetch
-    
+
     expect(ShipStation.limit).to eq(40)
     expect(ShipStation.remaining).to eq(39)
     expect(ShipStation.reset_time).to eq(20)

data/spec/ship_station/models/carrier_spec.rb

@@ -1,10 +1,10 @@
 RSpec.describe ShipStation::Carrier do
    before do
     stub_api_for(ShipStation::Carrier) do |stub|
-      stub.get("/carriers") do |env| 
+      stub.get("/carriers") do |env|
         [
-          200, 
-          {}, 
+          200,
+          {},
           { carriers: [{
                       "name": "Stamps.com",
                       "code": "stamps_com",
@@ -18,12 +18,12 @@ RSpec.describe ShipStation::Carrier do
             page: 1,
             pages: 1,
             total: 1
-          }.to_json 
+          }.to_json
         ]
       end
     end
   end
-  
+
   it "GET list" do
     carriers = ShipStation::Carrier.all.fetch
     expect(carriers.length).to eq(1)

data/spec/ship_station/models/customer_spec.rb

@@ -1,10 +1,10 @@
 RSpec.describe ShipStation::Customer do
    before do
     stub_api_for(ShipStation::Customer) do |stub|
-      stub.get("/customers") do |env| 
+      stub.get("/customers") do |env|
         [
-          200, 
-          {}, 
+          200,
+          {},
           { customers: [{
                         "customerId": 12345678,
                         "createDate": "2014-11-18T10:33:01.1900000",
@@ -15,26 +15,26 @@ RSpec.describe ShipStation::Customer do
             page: 1,
             pages: 1,
             total: 1
-          }.to_json 
+          }.to_json
         ]
-      end 
+      end
 
-      stub.get("/customers/12345678") do |env| 
+      stub.get("/customers/12345678") do |env|
         [
-          200, 
-          {}, 
+          200,
+          {},
           {
             "customerId": 12345678,
             "createDate": "2014-11-18T10:33:01.1900000",
             "modifyDate": "2014-11-18T10:33:01.1900000",
             "name": "Cam Newton",
             "company": "Test Company",
-            }.to_json 
+            }.to_json
         ]
-      end  
+      end
     end
   end
-  
+
   it "GET list" do
     customers = ShipStation::Customer.all.fetch
     expect(customers.length).to eq(1)

data/spec/ship_station/models/fulfillment_spec.rb

@@ -1,10 +1,10 @@
 RSpec.describe ShipStation::Fulfillment do
    before do
     stub_api_for(ShipStation::Fulfillment) do |stub|
-      stub.get("/fulfillments") do |env| 
+      stub.get("/fulfillments") do |env|
         [
-          200, 
-          {}, 
+          200,
+          {},
           { fulfillments: [
               {
                 "fulfillmentId": 33974374,
@@ -30,12 +30,12 @@ RSpec.describe ShipStation::Fulfillment do
             page: 1,
             pages: 1,
             total: 2
-          }.to_json 
+          }.to_json
         ]
-      end  
+      end
     end
   end
-  
+
   it "GET list" do
     fulfillments = ShipStation::Fulfillment.all.fetch
     expect(fulfillments.length).to eq(2)

data/spec/ship_station/models/order_spec.rb

@@ -1,10 +1,10 @@
 RSpec.describe ShipStation::Order do
    before do
     stub_api_for(ShipStation::Order) do |stub|
-      stub.get("/orders") do |env| 
+      stub.get("/orders") do |env|
         [
-          200, 
-          {}, 
+          200,
+          {},
           { orders: [{
                       "orderId"=>9222306,
                       "orderNumber"=>"1918",
@@ -16,14 +16,14 @@ RSpec.describe ShipStation::Order do
             page: 1,
             pages: 1,
             total: 1
-          }.to_json 
+          }.to_json
         ]
-      end 
+      end
 
-      stub.get("/orders/9222306") do |env| 
+      stub.get("/orders/9222306") do |env|
         [
-          200, 
-          {}, 
+          200,
+          {},
           {
             "orderId"=>9222306,
             "orderNumber"=>"1918",
@@ -31,12 +31,12 @@ RSpec.describe ShipStation::Order do
             "orderDate"=>"2016-08-08T16:48:30.0000000",
             "createDate"=>"2016-11-02T08:01:53.1400000",
             "modifyDate"=>"2016-11-02T08:01:46.3970000"
-          }.to_json 
+          }.to_json
         ]
-      end  
+      end
     end
   end
-  
+
   it "GET list" do
     orders = ShipStation::Order.all.fetch
     expect(orders.length).to eq(1)

data/spec/ship_station/models/product_spec.rb

@@ -1,10 +1,10 @@
 RSpec.describe ShipStation::Product do
    before do
     stub_api_for(ShipStation::Product) do |stub|
-      stub.get("/products") do |env| 
+      stub.get("/products") do |env|
         [
-          200, 
-          {}, 
+          200,
+          {},
           { products: [
               {
                 "aliases": nil,
@@ -24,25 +24,25 @@ RSpec.describe ShipStation::Product do
             page: 1,
             pages: 1,
             total: 2
-          }.to_json 
+          }.to_json
         ]
-      end 
+      end
 
-      stub.get("/products/7854008") do |env| 
+      stub.get("/products/7854008") do |env|
         [
-          200, 
-          {}, 
+          200,
+          {},
           {
             "aliases": nil,
             "productId": 7854008,
             "sku": "1005",
             "name": "Coffee Mug"
-          }.to_json 
+          }.to_json
         ]
-      end  
+      end
     end
   end
-  
+
   it "GET list" do
     products = ShipStation::Product.all.fetch
     expect(products.length).to eq(2)

data/spec/ship_station/models/shipment_spec.rb

@@ -1,10 +1,10 @@
 RSpec.describe ShipStation::Shipment do
    before do
     stub_api_for(ShipStation::Shipment) do |stub|
-      stub.get("/shipments") do |env| 
+      stub.get("/shipments") do |env|
         [
-          200, 
-          {}, 
+          200,
+          {},
           { shipments: [{
               shipmentId: 33974374,
               orderId: 43945660,
@@ -19,14 +19,14 @@ RSpec.describe ShipStation::Shipment do
             page: 1,
             pages: 1,
             total: 1
-          }.to_json 
+          }.to_json
         ]
-      end 
+      end
 
-      stub.get("/shipments/33974374") do |env| 
+      stub.get("/shipments/33974374") do |env|
         [
-          200, 
-          {}, 
+          200,
+          {},
           {
             shipmentId: 33974374,
             orderId: 43945660,
@@ -38,12 +38,12 @@ RSpec.describe ShipStation::Shipment do
             shipmentCost: 1.93,
             insuranceCost: 0,
             trackingNumber: "9400111899561704681189"
-          }.to_json 
+          }.to_json
         ]
-      end  
+      end
     end
   end
-  
+
   it "GET list" do
     shipments = ShipStation::Shipment.all.fetch
     expect(shipments.length).to eq(1)

data/spec/ship_station/models/store_spec.rb

@@ -1,10 +1,10 @@
 RSpec.describe ShipStation::Store do
    before do
     stub_api_for(ShipStation::Store) do |stub|
-      stub.get("/stores") do |env| 
+      stub.get("/stores") do |env|
         [
-          200, 
-          {}, 
+          200,
+          {},
           { stores: [
             {
               "storeId": 22766,
@@ -26,14 +26,14 @@ RSpec.describe ShipStation::Store do
             page: 1,
             pages: 1,
             total: 2
-          }.to_json 
+          }.to_json
         ]
-      end 
+      end
 
-      stub.get("/stores/22766") do |env| 
+      stub.get("/stores/22766") do |env|
         [
-          200, 
-          {}, 
+          200,
+          {},
           {
             "storeId": 22766,
             "storeName": "ShipStation Manual Store",
@@ -41,12 +41,12 @@ RSpec.describe ShipStation::Store do
             "marketplaceName": "ShipStation",
             "createDate": "2014-07-25T11:05:55.307",
             "modifyDate": "2014-11-12T08:45:20.55",
-          }.to_json 
+          }.to_json
         ]
-      end  
+      end
     end
   end
-  
+
   it "GET list" do
     stores = ShipStation::Store.all.fetch
     expect(stores.length).to eq(2)

data/spec/ship_station/models/warehouse_spec.rb

@@ -1,10 +1,10 @@
 RSpec.describe ShipStation::Warehouse do
    before do
     stub_api_for(ShipStation::Warehouse) do |stub|
-      stub.get("/warehouses") do |env| 
+      stub.get("/warehouses") do |env|
         [
-          200, 
-          {}, 
+          200,
+          {},
           [{
             "warehouseId": 17977,
             "warehouseName": "Main warehouse",
@@ -16,25 +16,25 @@ RSpec.describe ShipStation::Warehouse do
             "warehouseName": "Austin",
             "createDate": "2014-05-27T09:54:29.9600000",
             "isDefault": false
-          }].to_json 
+          }].to_json
         ]
-      end 
+      end
 
-      stub.get("/warehouses/17977") do |env| 
+      stub.get("/warehouses/17977") do |env|
         [
-          200, 
-          {}, 
+          200,
+          {},
           {
             "warehouseId": 17977,
             "warehouseName": "Main warehouse",
             "createDate": "2014-10-21T08:11:43.8800000",
             "isDefault": true
-          }.to_json 
+          }.to_json
         ]
-      end  
+      end
     end
   end
-  
+
   it "GET list" do
     warehouses = ShipStation::Warehouse.all.fetch
     expect(warehouses.length).to eq(2)

data/spec/spec_helper.rb

@@ -1,7 +1,12 @@
 require 'bundler/setup'
+require 'simplecov'
 require 'pry'
-require 'ship_station'
 
+SimpleCov.start do
+  add_filter '/spec'
+end
+
+require 'ship_station'
 
 RSpec.configure do |config|
   # Enable flags like --only-failures and --next-failure

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: ship_station
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.3
 platform: ruby
 authors:
 - Ben Jacobs
@@ -10,20 +10,6 @@ bindir: bin
 cert_chain: []
 date: 2018-10-29 00:00:00.000000000 Z
 dependencies:
-- !ruby/object:Gem::Dependency
-  name: launchy
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
 - !ruby/object:Gem::Dependency
   name: her
   requirement: !ruby/object:Gem::Requirement
@@ -94,29 +80,15 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3.0'
-- !ruby/object:Gem::Dependency
-  name: dotenv
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '2.2'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '2.2'
 description: Shipstation API
 email:
 - benjaminpjacobs@gmail.com
-executables:
-- console
+executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- bin/console
+- MIT-LICENSE
+- README.md
 - lib/ship_station.rb
 - lib/ship_station/api.rb
 - lib/ship_station/api/carrier.rb
@@ -154,7 +126,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '2.2'
+      version: '2.3'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="

data/bin/console

@@ -1,13 +0,0 @@
-#!/usr/bin/env ruby
-$:.push File.expand_path("lib", __FILE__)
-
-require "bundler/setup"
-
-require "ship_station"
-
-# You can add fixtures and/or initialization code here to make experimenting
-# with your gem easier. You can also use a different console, if you like.
-
-# (If you use this, don't forget to add pry to your Gemfile!)
-require 'pry'
-Pry.start