shipstation-rb 0.0.5

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 448a9a4571dcb325ba5f8fada723744c1a6a8931
+  data.tar.gz: b863c8faf50e9710192dd03f0d1a8897256c103b
+SHA512:
+  metadata.gz: 9131e977ec1a89341ad758a7f441b57cc71f80381a034ceb33ecc69b02abdc175a2c92c6712906644d823b7c7819c69ef4c425dc796445c826ba49efa720a2f3
+  data.tar.gz: 252017f623c8a0a2d1d97d09a12e88565fc34b3cd1e78f853f979dd513ed64642723c640da4223c6850b68ec8ba41a8887cd6269ce4a28c8331eee74d3dc0fb1

data/.gitignore

@@ -0,0 +1,20 @@
+# 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/
+*.gem

data/Gemfile

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

data/Gemfile.lock

@@ -0,0 +1,61 @@
+PATH
+  remote: .
+  specs:
+    shipstation-ruby (0.0.2)
+      rash (= 0.4.0)
+      ruby_odata (= 0.1.6)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    activesupport (4.0.5)
+      i18n (~> 0.6, >= 0.6.9)
+      minitest (~> 4.2)
+      multi_json (~> 1.3)
+      thread_safe (~> 0.1)
+      tzinfo (~> 0.3.37)
+    addressable (2.3.6)
+    ansi (1.4.3)
+    crack (0.4.2)
+      safe_yaml (~> 1.0.0)
+    hashie (2.0.5)
+    i18n (0.6.9)
+    mime-types (2.3)
+    mini_portile (0.6.0)
+    minitest (4.7.5)
+    multi_json (1.10.1)
+    nokogiri (1.6.2.1)
+      mini_portile (= 0.6.0)
+    rake (10.3.2)
+    rash (0.4.0)
+      hashie (~> 2.0.0)
+    rest-client (1.6.7)
+      mime-types (>= 1.16)
+    ruby_odata (0.1.6)
+      activesupport (>= 3.0.0)
+      addressable (>= 2.3.4)
+      i18n (~> 0.6.0)
+      nokogiri (>= 1.4.2)
+      rest-client (>= 1.5.1)
+    safe_yaml (1.0.3)
+    thread_safe (0.3.4)
+    turn (0.9.7)
+      ansi
+      minitest (~> 4)
+    tzinfo (0.3.39)
+    vcr (2.9.2)
+    webmock (1.18.0)
+      addressable (>= 2.3.6)
+      crack (>= 0.3.2)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (= 1.3.5)
+  minitest (~> 4.2)
+  rake
+  shipstation-ruby!
+  turn
+  vcr
+  webmock

data/README.md

@@ -0,0 +1,162 @@
+shipstation-ruby
+================
+
+This is a Ruby wrapper for [ShipStation](http://www.shipstation.com/)'s [OData API](http://api.shipstation.com/MainPage.ashx).
+
+## 0.0.1 Features
+[here](https://github.com/codyduval/shipstation-ruby)
+
+## 0.0.2 Features
+
+* Support spacename, You can use it with rails model Order and SS::Order. `SS` is default namespace.
+* Support api host
+* Collection Create
+
+## 0.0.3 Features
+
+* Collection Update
+* Collection Delete( set attr Active = false )
+* Collection Destroy( call `delete_object` )
+
+## 0.0.4 Features
+
+* Collection First
+* Collection Last
+* Collection Count
+* Collection return Rash instance
+* Collection Create return a instance, not Array.
+* Collection Where by array
+* Collection Where by String. eg. `client.orders.where("CreateDate ge datetime'2014-06-17'")` 
+You can write a filter string, read more [here](http://msdn.microsoft.com/en-us/library/ff478141.aspx), [here](http://www.odata.org/documentation/odata-version-3-0/odata-version-3-0-core-protocol), and [here](http://docs.oasis-open.org/odata/odata/v4.0/os/part1-protocol/odata-v4.0-os-part1-protocol.html#_Built-in_Query_Functions)
+* Test with shipstation api 1.3
+
+## 0.0.5 Features
+
+Rename the gem to shipstation-rb.
+
+
+## Installation
+
+``` ruby
+gem 'shipstation-rb', '~> 0.0.4'
+gem 'awesome_print', :require => 'ap'
+```
+
+## 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
+ShipStation.username  = ENV['SHIPSTATION_USERNAME']
+ShipStation.password  = ENV['SHIPSTATION_PASSWORD']
+ShipStation.api_host  = ENV['SHIPSTATION_API_HOST']
+```
+
+OR
+
+```ruby
+require "shipstation"
+client = ShipStation::Client.new(APICONFIG[:ship_station_api], APICONFIG[:ship_station_account], APICONFIG[:ship_station_password])
+```
+
+## Usage
+
+### Set your credentials and create a new client:
+``` ruby
+ShipStation.api_host  = "https://data.shipstation.com/1.3"
+ShipStation.password  = "shipstation_password"
+ShipStation.password  = "shipstation_password"
+client = ShipStation::Client.new
+```
+
+### Or create a new client by passing credentials directly:
+``` ruby
+client = ShipStation::Client.new("https://data.shipstation.com/1.3", "username", "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 = ShipStation::Client.new
+order = client.order.find(12345)
+
+order.order_id ## 12345
+order.ship_city ## Boise
+order.order_total ## $343.32
+```
+
+### Create order
+```ruby
+client = ShipStation::Client.new
+client.order.create(OrderNumber: "T0001", OrderStatusID: 2)
+```
+
+### Update order
+```ruby
+client = ShipStation::Client.new
+client.order.Update(1234, OrderNumber: "T0002", OrderStatusID: 2)
+```
+
+### Delete order
+```ruby
+client = ShipStation::Client.new
+client.orders.delete(1234)  #=> order.active = false
+```
+
+### Destory order
+```ruby
+client = ShipStation::Client.new
+client.orders.destory(1234) # svc.delete_object(klass)
+```
+
+### List all stores
+```ruby
+client = ShipStation::Client.new
+client.stores.all
+```
+
+### First of clollection
+```ruby
+client = ShipStation::Client.new
+client.stores.first
+```
+
+### Last of clollection
+```ruby
+client = ShipStation::Client.new
+client.stores.last
+```
+
+## Requirements
+This gem has been tested on Ruby 1.9.3 on version 1.1 of ShipStation's API.(by author)
+This gem has been tested on Ruby ruby-2.0.0-p247 on version 1.2 and 1.3 of ShipStation's API.(By Rique Li)
+
+## About This Gem
+
+I am Rique Li, I fork this from [shipstation-ruby](https://github.com/codyduval/shipstation-ruby/) and make some changes, when all test done, I will make a PR.
+
+If You like this gem, write me. ^_^
+
+

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.rb"
+end
+ 
+Rake::TestTask.new do |t|
+  t.test_files = FileList['spec/lib/shipstation/*_spec.rb']
+  t.verbose = true
+end
+ 
+task :default => :test

data/lib/shipstation.rb

@@ -0,0 +1,15 @@
+require "rash"
+require "ruby_odata"
+
+require "shipstation/client"
+require "shipstation/collection"
+require "shipstation/version"
+
+module ShipStation
+
+  class ShipStationError < StandardError; end
+  class AuthenticationError < ShipStationError; end
+  class ConfigurationError < ShipStationError; end
+  class QueryError < ShipStationError; end
+
+end

data/lib/shipstation/client.rb

@@ -0,0 +1,31 @@
+module ShipStation
+  class Client
+    attr_accessor :auth, :client, :namespace
+
+    # require "shipstation"
+    # client = ShipStation::Client.new(APICONFIG[:ship_station_api], APICONFIG[:ship_station_account], APICONFIG[:ship_station_password])
+    def initialize(api_host, username, password, namespace = "SS")
+      raise ArgumentError unless username && password && api_host
+      @auth = {:username => username, :password => password, :namespace => namespace}
+      @client = OData::Service.new(api_host, @auth)
+      @namespace = namespace
+    end
+
+    # client.orders.all
+    # client.ShippingProviders.all
+    # client.stores.all
+    # client.orders.create(OrderNumber: "Test0001", OrderStatusID; 2)
+    # client.orders.where("CreateDate ge datetime'2014-06-17'")
+    def method_missing(method, *args, &block)
+      method = method.to_s
+      options = args.last.is_a?(Hash) ? args.pop : {}
+      klass = method.pluralize.camelize
+      ShipStation::Collection.new(@client, klass, @namespace)
+    end
+
+    def inspect
+      "#<ShipStation::Client:#{object_id}>"
+    end
+
+  end
+end

data/lib/shipstation/collection.rb

@@ -0,0 +1,115 @@
+module ShipStation
+  class Collection
+
+    attr_accessor :client, :klass, :namespace
+
+    def initialize(client, klass, namespace)
+      @client = client
+      @klass = klass
+      @namespace = namespace
+    end
+
+    def find(id)
+      @client.send("#{@klass}", id)
+      result = @client.execute.first
+      hashie_object(result)
+    end
+
+    def all
+      @client.send("#{@klass}")
+      results = @client.execute
+      results.map{|rrr| hashie_object(rrr) }
+    end
+
+    # filter
+    # http://msdn.microsoft.com/en-us/library/ff478141.aspx
+    # http://www.odata.org/documentation/odata-version-3-0/odata-version-3-0-core-protocol
+    # http://docs.oasis-open.org/odata/odata/v4.0/os/part1-protocol/odata-v4.0-os-part1-protocol.html#_Built-in_Query_Functions
+    def where(query)
+      if query.is_a?(Hash)
+        query_string = ""
+        query_array = []
+        query.each do |key, val|
+          # shipstation_style_attribute = attribute.to_s.classify.gsub(/Id/, 'ID')
+          if val.is_a?(Integer)
+            filter_string = "#{key} eq #{val}"
+          elsif val.is_a?(String)
+            filter_string = "#{key} eq '#{val}'"
+          else
+            raise ShipStation::QueryError, "Query value incorrect."
+          end
+          query_array << filter_string
+        end
+        query_string = query_array.join(' and ')
+      elsif query.is_a?(String)
+        query_string = query
+      else
+        raise ShipStation::QueryError, "Query incorrect."
+      end
+      @client.send("#{@klass}").filter("#{query_string}")
+      results = @client.execute
+      results.map{|rrr| hashie_object(rrr) }
+    end
+
+    def first
+      @client.send("#{@klass}").send("order_by", "CreateDate asc").send("top", 1)
+      result = @client.execute.first
+      hashie_object(result)
+    end
+
+    def last
+      @client.send("#{@klass}").send("order_by", "CreateDate desc").send("top", 1)
+      result = @client.execute.first
+      hashie_object(result)
+    end
+
+    def count
+      @client.send("#{@klass}").send("count")
+      @client.execute
+    end
+
+    # client.order.create(OrderNumber: "HAHA1111", OrderStatusID: 2)
+    def create(attrs={})
+      klazz = "#{@namespace}::#{@klass.singularize}".constantize.new
+      attrs.each do |key, val|
+        klazz.send("#{key.to_s}=", val)
+      end
+      @client.send("AddTo#{@klass}", klazz)
+      result = @client.send("save_changes").first
+      hashie_object(result)
+    end
+
+    # client.orders.update(43478396, OrderNumber: "HAHA1111")
+    def update(id, attrs={})
+      @client.send("#{@klass}", id)
+      klazz = @client.execute.last
+      attrs.each do |key, val|
+        klazz.send("#{key.to_s}=", val)
+      end
+      @client.send("update_object", klazz)
+      @client.send("save_changes")
+    end
+
+    # client.orders.delete(123)
+    def delete(id)
+      update(id, {active: false})
+    end
+
+    # client.orders.destroy(123)
+    def destroy(id)
+      @client.send("#{@klass}", id)
+      klazz = @client.execute.last
+      @client.send("delete_object", klazz)
+      @client.send("save_changes")
+    end
+
+    private
+
+      def hashie_object(result)
+        return if result.nil?
+        result_hash = JSON.parse(result.to_json)
+        Hashie::Rash.new(result_hash)
+      end
+
+  end
+end

data/lib/shipstation/version.rb

@@ -0,0 +1,3 @@
+module ShipStation
+  VERSION = "0.0.5"
+end

data/shipstation.gemspec

@@ -0,0 +1,29 @@
+# -*- encoding: utf-8 -*-
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "shipstation/version"
+
+Gem::Specification.new do |gem|
+  gem.name          = "shipstation-rb"
+  gem.version       = ShipStation::VERSION
+  gem.licenses      = 'MIT'
+  gem.authors       = ["Rique Li"]
+  gem.email         = ["hi@liwei.me"]
+  gem.description   = 'An API wrapper for the ShipStation API.base on Cody Duval\'s 0.0.1'
+  gem.summary       = 'Ruby wrapper ShipStation API'
+  gem.homepage      = 'https://github.com/liwei78/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', '0.4.0'
+  gem.add_dependency 'ruby_odata', '0.1.6'
+  gem.add_development_dependency 'minitest', '~> 4.2'
+  gem.add_development_dependency 'turn', '~> 0.9'
+  gem.add_development_dependency 'rake', '~> 10.3'
+  gem.add_development_dependency 'vcr', '~> 2.9'
+  gem.add_development_dependency 'webmock', '~> 1.18'
+  gem.add_development_dependency 'bundler', '1.3.5'
+end

metadata

@@ -0,0 +1,166 @@
+--- !ruby/object:Gem::Specification
+name: shipstation-rb
+version: !ruby/object:Gem::Version
+  version: 0.0.5
+platform: ruby
+authors:
+- Rique Li
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-06-18 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rash
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.4.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.4.0
+- !ruby/object:Gem::Dependency
+  name: ruby_odata
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.1.6
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.1.6
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '4.2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '4.2'
+- !ruby/object:Gem::Dependency
+  name: turn
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.9'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.9'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '10.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '10.3'
+- !ruby/object:Gem::Dependency
+  name: vcr
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.9'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.9'
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.18'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.18'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 1.3.5
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 1.3.5
+description: An API wrapper for the ShipStation API.base on Cody Duval's 0.0.1
+email:
+- hi@liwei.me
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- Gemfile.lock
+- README.md
+- Rakefile
+- lib/shipstation.rb
+- lib/shipstation/client.rb
+- lib/shipstation/collection.rb
+- lib/shipstation/version.rb
+- shipstation.gemspec
+homepage: https://github.com/liwei78/shipstation-ruby
+licenses:
+- MIT
+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.2.0
+signing_key: 
+specification_version: 4
+summary: Ruby wrapper ShipStation API
+test_files: []