shipstation-ruby 0.0.1

checksums.yaml

@@ -0,0 +1,15 @@
+---
+!binary "U0hBMQ==":
+  metadata.gz: !binary |-
+    ODNmZGJlNmM4OTdmMGY1MmI5ZDM2ZjczMmQ1YzdhN2NiYWUwZjVlOA==
+  data.tar.gz: !binary |-
+    ZjdiZTJkYmE3ZWY1MGE2NWQwZTQ2NjljZTgwNWUyODJkNTE1Njk4MA==
+!binary "U0hBNTEy":
+  metadata.gz: !binary |-
+    MGRkNjU2NmJiZTVhNGQyYzA4ZDNjMWZjOTkwY2JiYWE2NGFlMGVlODQ3ODAw
+    NjEyNGU4YTg3OTAzZmUyNThmYWFlMDVmYzdlYzY0Mzk2OTE3MDM5MGYwOWYy
+    MTliNDViMDM0ZWZlZDQzYTBhYzc0ZTk3Yjc1NjZhMzBlODEyOTk=
+  data.tar.gz: !binary |-
+    OTQzNDIwZTVlM2RlYWY2ODhkZTQ1YmE1YzYwMzQ2YTBlMTE0ODlkMWE0MzY0
+    ZDFkYTM0YWU1OTRkZmRjYjljYTE5ZjFlNDlhZGQ5OGM1MTEzZDBjMmM0YTdl
+    ZjI5Yjg0MjIzMDJlZjljODFkZWNhODg4MWU4YzJkYzFlYmRhMTk=

data/.gitignore

@@ -0,0 +1,19 @@
+# See http://help.github.com/ignore-files/ for more about ignoring files.
+#
+# If you find yourself ignoring temporary files generated by your text editor
+# or operating system, you probably want to add a global ignore instead:
+#   git config --global core.excludesfile ~/.gitignore_global
+
+# Ignore bundler config
+/.bundle
+
+# Ignore the default SQLite database.
+/db/*.sqlite3
+
+# Ignore all logfiles and tempfiles.
+/log/*.log
+/tmp
+/solr/data/development/index
+
+# Ignore all VCR fixtures
+/spec/fixtures/

data/Gemfile

@@ -0,0 +1,3 @@
+source 'https://rubygems.org'
+ 
+gemspec

data/Gemfile.lock

@@ -0,0 +1,52 @@
+PATH
+  remote: .
+  specs:
+    shipstation-ruby (0.0.1)
+      rash
+      ruby_odata
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    activesupport (3.2.12)
+      i18n (~> 0.6)
+      multi_json (~> 1.0)
+    addressable (2.3.4)
+    ansi (1.4.3)
+    backports (3.3.0)
+    crack (0.3.2)
+    hashie (2.0.3)
+    i18n (0.6.4)
+    mime-types (1.22)
+    minitest (4.7.1)
+    multi_json (1.7.2)
+    nokogiri (1.5.9)
+    rake (10.0.4)
+    rash (0.4.0)
+      hashie (~> 2.0.0)
+    rest-client (1.6.7)
+      mime-types (>= 1.16)
+    ruby_odata (0.1.2)
+      activesupport (>= 3.0.0)
+      backports (>= 2.3.0)
+      i18n (~> 0.6.0)
+      nokogiri (>= 1.4.2)
+      rest-client (>= 1.5.1)
+    turn (0.9.6)
+      ansi
+    vcr (2.4.0)
+    webmock (1.11.0)
+      addressable (>= 2.2.7)
+      crack (>= 0.3.2)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler
+  minitest
+  rake
+  shipstation-ruby!
+  turn
+  vcr
+  webmock

data/README.md

@@ -0,0 +1,100 @@
+shipstation-ruby
+================
+
+This is a Ruby wrapper for [ShipStation](http://www.shipstation.com/)'s [OData API](http://api.shipstation.com/MainPage.ashx).
+
+This is version 0.0.1 of the gem.  It currently only supports querying and filtering of ShipStation resources.
+
+## Installation
+
+ShipStation-Ruby is packaged as a Ruby gem. I recommend you install it with [Bundler](http://gembundler.com/) by adding the following line to your Gemfile:
+[ShipStation](http://ww.shipstation.com/)'s Ruby client library is an interface to its
+[OAuth API](http://api.shipstation.com/MainPage.ashx).
+
+
+``` ruby
+gem 'shipstation-ruby', '~> 0.0.1'
+```
+
+## Rails Configuration
+
+The ShipStation API uses basic HTTP authentication. Inside config/initializers, create a new configuration file and use the following template to pass in your ShipStation credentials:
+
+``` ruby
+ShipStationRuby.username  = ENV['SHIPSTATION_USERNAME']
+ShipStationRuby.password  = ENV['SHIPSTATION_PASSWORD']
+```
+
+## Usage
+
+### Set your credentials and create a new client:
+``` ruby
+ShipStationRuby.username  = "shipstation_username"
+ShipStationRuby.password  = "shipstation_password"
+client = ShipStationRuby::Client.new
+```
+
+### Or create a new client by passing credentials directly:
+``` ruby
+client = ShipStationRuby::Client.new("shipstation_username", "shipstation_password")
+```
+### Query a resource by record id:
+``` ruby
+order = client.order.find(12345)
+```
+
+### Get all records for any given resource in an array (paginated in batches of 100):
+``` ruby
+orders = client.order.all
+```
+
+### Query records for any resource by any attribute, returns an array:
+``` ruby
+open_texas_orders = client.order.where("active" => "true", "ship_state" => "TX")
+```
+
+### Other resources follow a similar pattern
+``` ruby
+all_warehouses = client.warehouse.all
+customer_12345 = client.customer.find(12345)
+texas_fedex_shipments = client.shipment.where("shipping_service_id" => 0001, "state" => "TX")
+```
+etc.
+
+### Once returned, resources can be queried by field name
+``` ruby
+client = ShipStationRuby::Client.new
+order = client.order.find(12345)
+
+order.order_id ## 12345
+order.ship_city ## Boise
+order.order_total ## $343.32
+```
+
+## Requirements
+This gem has been tested on Ruby 1.9.3 on version 1.1 of ShipStation's API.
+
+## Bugs
+Please report bugs at https://github.com/codyduval/shipstation-ruby/issues
+
+## Note on Patches/Pull Requests
+* Fork the project from https://github.com/codyduval/shipstation-ruby/
+* Make your feature addition or bug fix.
+* Add tests
+* Commit
+* Send me a pull request. Bonus points for topic branches.
+
+## Thanks
+Thanks to [Nate Berkopec](https://github.com/nateberkopec) for advice and guidance.
+
+## License
+
+(The MIT License.)
+
+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/Rakefile

@@ -0,0 +1,14 @@
+require 'rake/testtask'
+require "bundler/gem_tasks"
+
+desc "Open an irb session preloaded with this library"
+task :console do
+  sh "irb -rubygems -I lib -I extra -r shipstation_ruby.rb"
+end
+ 
+Rake::TestTask.new do |t|
+  t.test_files = FileList['spec/lib/shipstation_ruby/*_spec.rb']
+  t.verbose = true
+end
+ 
+task :default => :test

data/lib/shipstation_ruby.rb

@@ -0,0 +1,33 @@
+require "rash"
+require "ruby_odata"
+require "awesome_print"
+
+require "shipstation_ruby/client"
+require "shipstation_ruby/collection"
+
+module ShipStationRuby
+  API_BASE = "https://data.shipstation.com/1.1"
+
+  class ShipStationRubyError < StandardError
+  end
+
+  class AuthenticationError < ShipStationRubyError; end
+  class ConfigurationError < ShipStationRubyError; end
+
+  class << self
+   def username
+      defined? @username and @username or raise(
+        ConfigurationError, "ShipStationRuby username not configured"
+      )
+    end
+    attr_writer :username
+
+    def password
+      defined? @password and @password or raise(
+        ConfigurationError, "ShipStationRuby password not configured"
+      )
+    end
+    attr_writer :password
+
+  end
+end

data/lib/shipstation_ruby/client.rb

@@ -0,0 +1,27 @@
+module ShipStationRuby
+  class Client
+    attr_accessor :auth, :client
+
+    def initialize(username = ShipStationRuby.username, password = ShipStationRuby.password)
+      raise ArgumentError unless username && password
+      @auth = {:username => username, :password => password}
+
+      @client = OData::Service.new(API_BASE, @auth)
+      self
+    end
+
+    def method_missing(method, *args, &block)
+      method = method.to_s
+      options = args.last.is_a?(Hash) ? args.pop : {}
+
+      # method == 'orders'
+      klass = method.pluralize.camelize
+      ShipStationRuby::Collection.new(@client, klass)
+    end
+
+    def inspect
+      "#<ShipStationRuby::Client:#{object_id}>"
+    end
+
+  end
+end

data/lib/shipstation_ruby/collection.rb

@@ -0,0 +1,61 @@
+module ShipStationRuby
+  class Collection
+
+    attr_accessor :client, :resource
+
+    def initialize(client, resource)
+      @client = client
+      @resource = resource
+    end
+
+    def find(id)
+      @client.send("#{@resource}",id)
+      result = @client.execute
+      single_result = result.first
+      json_hash = JSON.parse(single_result.to_json)
+      json_rash = Hashie::Rash.new(json_hash)
+      return json_rash
+    end
+
+    def all
+      @client.send("#{@resource}")
+      results = @client.execute
+      formatted_results = []
+      results.each do |result|
+        result_hash = JSON.parse(result.to_json)
+        result_rash = Hashie::Rash.new(result_hash)
+        formatted_results.push(result_rash)
+      end
+      return formatted_results
+    end
+
+    def where(filters={})
+      final_string = ""
+      final_string_array = []
+      filters.each do |attribute, value|
+        shipstation_style_attribute = attribute.to_s.classify.gsub(/Id/, 'ID')
+        puts shipstation_style_attribute
+        puts value
+        if value.is_a?(Integer)
+          filter_string = "#{shipstation_style_attribute} eq #{value}"
+        else
+          filter_string = "#{shipstation_style_attribute} eq '#{value}'"
+        end
+
+        final_string_array << filter_string
+      end
+      final_string = final_string_array.join(' and ')
+      puts final_string
+      @client.send("#{@resource}").filter("#{final_string}")
+      results = @client.execute
+      formatted_results = []
+      results.each do |result|
+        result_hash = JSON.parse(result.to_json)
+        result_rash = Hashie::Rash.new(result_hash)
+        formatted_results.push(result_rash)
+      end
+      return formatted_results
+    end
+
+  end
+end

data/shipstation-ruby.gemspec

@@ -0,0 +1,27 @@
+# -*- encoding: utf-8 -*-
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+
+Gem::Specification.new do |gem|
+  gem.name          = "shipstation-ruby"
+  gem.version       = "0.0.1"
+  gem.authors       = ["Cody Duval"]
+  gem.email         = ["cody.duval@gmail.com"]
+  gem.description   = 'An API wrapper for the ShipStation API'
+  gem.summary       = 'An API wrapper for the ShipStation API'
+  gem.homepage      = 'https://github.com/codyduval/shipstation-ruby'
+
+  gem.files         = `git ls-files`.split($/)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.require_paths = ["lib"]
+
+  gem.add_dependency 'rash'
+  gem.add_dependency 'ruby_odata'
+  gem.add_development_dependency 'minitest'
+  gem.add_development_dependency 'turn'
+  gem.add_development_dependency 'rake'
+  gem.add_development_dependency 'vcr'
+  gem.add_development_dependency 'webmock'
+  gem.add_development_dependency 'bundler'
+end

data/spec/lib/shipstation_ruby/client_spec.rb

@@ -0,0 +1,16 @@
+require_relative '../../spec_helper'
+
+describe ShipStationRuby::Client do
+  it "sets authentication on initialize with passed parameters" do
+    client_test = VCR.use_cassette('get_metadata') do
+      ShipStationRuby::Client.new
+    end
+    client_test.auth[:username].must_equal ShipStationRuby.username
+    client_test.auth[:password].must_equal ShipStationRuby.password
+  end
+
+  it "must have a username and password" do
+    proc { ShipStationRuby::Client.new("username", nil) }.must_raise ArgumentError
+  end
+
+end

data/spec/lib/shipstation_ruby/collection_spec.rb

@@ -0,0 +1,35 @@
+require_relative '../../spec_helper'
+
+describe ShipStationRuby::Collection do
+  let(:client) { ShipStationRuby::Client.new }
+
+  it "initializes new Collection" do
+    @resource = "orders"
+    ShipStationRuby::Collection.new(@client, @resource).must_be_instance_of ShipStationRuby::Collection
+  end
+
+  describe "It must correctly find Order resource" do
+    let(:client) { ShipStationRuby::Client.new }
+
+    it "must contain correct client and class" do
+      @resource = "orders"
+      collection = ShipStationRuby::Collection.new(@client, @resource)
+      
+      collection.client.must_equal @client
+      collection.resource.must_equal "orders"
+    end
+  end
+
+  describe "It must correctly find Warehouse resource" do
+    let(:client) { ShipStationRuby::Client.new }
+
+    it "must contain correct client and class" do
+      @resource = "warehouses"
+      collection = ShipStationRuby::Collection.new(@client, @resource)
+      
+      collection.client.must_equal @client
+      collection.resource.must_equal "warehouses"
+    end
+  end
+
+end

data/spec/lib/shipstation_ruby/extensions_spec.rb

@@ -0,0 +1,20 @@
+require_relative '../../spec_helper'
+
+describe 'HashieMash extensions' do
+  it "must convert CamelCase keys to snake_case" do
+    test_hash = {"TopLevel" => "Top level value"}
+    
+    test_rash = Hashie::Rash.new(test_hash)
+
+    test_rash.must_equal({"top_level" => "Top level value"})
+  end
+
+  it "must convert nested CamelCase keys to snake_case" do
+    test_hash = {"TopLevel" => {"SecondLevel" => {"ThirdLevel" => 9999 }}}
+    
+    test_rash = Hashie::Rash.new(test_hash)
+
+    test_rash.must_equal({"top_level" => {"second_level" => {"third_level" => 9999 }}})
+  end
+
+end

data/spec/lib/shipstation_ruby/order_spec.rb

@@ -0,0 +1,55 @@
+require_relative '../../spec_helper'
+
+describe "ShipStationRuby::Order metaclass" do
+
+  describe "Find order" do
+    let(:client) { ShipStationRuby::Client.new }
+
+    it "must find the right Order from the OData service" do
+      VCR.use_cassette('find_order') do
+        client.orders.find(21660574).order_id.must_equal 21660574
+      end
+    end
+
+    it "must return a Rash object" do
+      VCR.use_cassette('find_order') do
+        client.orders.find(21660574).must_be_instance_of Hashie::Rash
+      end
+    end
+  end
+
+  describe "all orders" do
+    let(:client) { ShipStationRuby::Client.new }
+
+    it "must return an array of Rash objects" do
+      VCR.use_cassette('all_orders') do
+        client.orders.all.must_be_instance_of Array
+      end
+    end
+  end
+
+  describe "GET filtered order" do
+    let(:client) { ShipStationRuby::Client.new }
+
+    it "must get the correct filtered result with one parameter" do
+      VCR.use_cassette('filtered_order_one_param') do
+        order = client.orders.where("customer_id"=> 15843013).first
+        order.order_id.must_equal 21660574
+      end
+    end
+
+    it "must get the correct filtered result with two passed parameters" do
+      VCR.use_cassette('filtered_order_two_params') do
+        order = client.orders.where("order_id" => 21660574, "seller_id" => 105162).first
+        order.order_id.must_equal 21660574
+      end
+    end
+  end
+
+  describe "Update order attributes" do
+    
+  end
+
+
+end
+

data/spec/spec_helper.rb

@@ -0,0 +1,26 @@
+require_relative '../lib/shipstation_ruby'
+
+require 'minitest/autorun'
+require 'webmock/minitest'
+require 'vcr'
+require 'turn/autorun'
+ 
+Turn.config do |c|
+  c.format  = :outline
+  c.natural = true
+  c.verbose = true
+end
+ 
+VCR.configure do |c|
+  c.cassette_library_dir = 'spec/fixtures/shipstation_ruby_cassettes'
+  c.hook_into :webmock
+end
+
+#environment vars
+include ShipStationRuby
+ShipStationRuby.username = 'shipstation_username'
+ShipStationRuby.password = 'shipstation_password'
+
+ShipStationRuby.username != 'shipstation_username' or raise(
+        ConfigurationError, "ShipStationRuby username and password not configured"
+  )

metadata

@@ -0,0 +1,175 @@
+--- !ruby/object:Gem::Specification
+name: shipstation-ruby
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Cody Duval
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-04-17 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rash
+  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: ruby_odata
+  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: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: turn
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: vcr
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: An API wrapper for the ShipStation API
+email:
+- cody.duval@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- Gemfile.lock
+- README.md
+- Rakefile
+- lib/shipstation_ruby.rb
+- lib/shipstation_ruby/client.rb
+- lib/shipstation_ruby/collection.rb
+- shipstation-ruby.gemspec
+- spec/lib/shipstation_ruby/client_spec.rb
+- spec/lib/shipstation_ruby/collection_spec.rb
+- spec/lib/shipstation_ruby/extensions_spec.rb
+- spec/lib/shipstation_ruby/order_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/codyduval/shipstation-ruby
+licenses: []
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.0.3
+signing_key: 
+specification_version: 4
+summary: An API wrapper for the ShipStation API
+test_files:
+- spec/lib/shipstation_ruby/client_spec.rb
+- spec/lib/shipstation_ruby/collection_spec.rb
+- spec/lib/shipstation_ruby/extensions_spec.rb
+- spec/lib/shipstation_ruby/order_spec.rb
+- spec/spec_helper.rb
+has_rdoc: