ship_compliant 0.1.2 → 0.2.0

data/lib/ship_compliant/search_more_sales_orders.rb

@@ -0,0 +1,38 @@
+module ShipCompliant
+  # == ShipCompliant::SearchMoreSalesOrders
+  #
+  # This method is used in conjunction with SearchSalesOrders to get more
+  # results from the search that was performed using SearchSalesOrders. This
+  # method will return 100 results each time.
+  #
+  # Only use this method in conjunction with SearchSalesOrders. When there are
+  # more results available from the search, call this method with the token
+  # returned from the SearchSalesOrders results or returned from a subsequent
+  # call of SearchMoreSalesOrders to see the next page of results.
+  #
+  #   orders = ShipCompliant::SearchMoreSalesOrders.paging_cookie('paging-cookie')
+  #
+  #   puts "#{orders.remaining_orders_length} orders left"
+  #   
+  #   orders.summaries.each do |summary|
+  #     puts summary.purchase_date #=> DateTime
+  #   end
+  class SearchMoreSalesOrders
+
+    # Finds the next 100 orders by a paging cookie. You can get the paging
+    # cookie from ShipCompliant::SearchSalesOrders#paging_cookie.
+    #
+    # Returns an instance of ShipCompliant::SearchSalesOrdersResult.
+    #
+    #   orders = ShipCompliant::SearchMoreSalesOrders.paging_cookie('paging-cookie')
+    #   puts orders.length #=> 100
+    def self.paging_cookie(cookie)
+      sales = ShipCompliant.client.call(:search_more_sales_orders, {
+        'PagingCookie' => cookie
+      })
+
+      r = SearchSalesOrdersResult.new(sales)
+    end
+  end
+end
+

data/lib/ship_compliant/version.rb

@@ -1,3 +1,3 @@
 module ShipCompliant
-  VERSION = "0.1.2"
+  VERSION = "0.2.0"
 end

data/lib/ship_compliant.rb

@@ -20,6 +20,8 @@ require "ship_compliant/search_sales_orders"
 require "ship_compliant/search_sales_orders_result"
 require "ship_compliant/search_sales_order_summary"
 
+require "ship_compliant/search_more_sales_orders"
+
 require "ship_compliant/get_sales_order_extended"
 require "ship_compliant/get_sales_order_extended_result"
 

data/ship_compliant.gemspec

@@ -26,6 +26,7 @@ Gem::Specification.new do |s|
   s.add_development_dependency "bundler", "~> 1.5"
   s.add_development_dependency "rake", "~> 10.0"
   s.add_development_dependency "sdoc", "~> 0.4"
+  s.add_development_dependency "pry", "~> 0.9"
 
   # TESTING
   s.add_development_dependency "rspec", "~> 2.13"

data/spec/lib/ship_compliant/search_more_sales_orders_spec.rb

@@ -0,0 +1,29 @@
+require "spec_helper"
+
+module ShipCompliant
+  describe SearchMoreSalesOrders do
+
+    before { savon.mock! }
+    after { savon.unmock! }
+
+    let(:message) do
+      {
+        'Request' =>  {
+          'Security' => ShipCompliant.configuration.credentials,
+          'PagingCookie' => 'paging-cookie'
+        }
+      }
+    end
+
+    context "paging_cookie" do
+      it "finds orders by paging cookie" do
+        savon.expects(:search_more_sales_orders)
+          .with(message: message)
+          .returns(File.read('spec/fixtures/search_sales_orders.xml'))
+
+        SearchMoreSalesOrders.paging_cookie('paging-cookie')
+      end
+    end
+
+  end
+end

data/spec/spec_helper.rb

@@ -8,6 +8,7 @@ require "rspec"
 require "set"
 require 'ship_compliant'
 require "savon/mock/spec_helper"
+require "pry"
 
 RSpec.configure do |config|
   config.include Savon::SpecHelper

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ship_compliant
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.2.0
 platform: ruby
 authors:
 - Baylor Rae'
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-03-28 00:00:00.000000000 Z
+date: 2014-04-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -86,6 +86,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '0.4'
+- !ruby/object:Gem::Dependency
+  name: pry
+  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: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -163,6 +177,7 @@ files:
 - features/commit_sales_order.feature
 - features/get_inventory_details.feature
 - features/get_sales_order_extended.feature
+- features/search_more_sales_orders.feature
 - features/search_sales_orders.feature
 - features/step_definitions/brand_steps.rb
 - features/step_definitions/commit_sales_order/all_shipments.rb
@@ -173,6 +188,7 @@ files:
 - features/step_definitions/inventory_steps.rb
 - features/step_definitions/product_steps.rb
 - features/step_definitions/sales_order_extended_steps.rb
+- features/step_definitions/search_more_orders_steps.rb
 - features/step_definitions/search_order_steps.rb
 - features/step_definitions/void_order_steps.rb
 - features/support/env.rb
@@ -193,6 +209,8 @@ files:
 - fixtures/vcr_cassettes/product_valid_brand.yml
 - fixtures/vcr_cassettes/sales_order_extended.yml
 - fixtures/vcr_cassettes/sales_order_missing.yml
+- fixtures/vcr_cassettes/sales_order_more.yml
+- fixtures/vcr_cassettes/search_more_orders_invalid_cookie.yml
 - fixtures/vcr_cassettes/search_sales_orders.yml
 - fixtures/vcr_cassettes/update_product.yml
 - fixtures/vcr_cassettes/void_order.yml
@@ -225,6 +243,7 @@ files:
 - lib/ship_compliant/product_attributes.rb
 - lib/ship_compliant/product_sales_tax_rate.rb
 - lib/ship_compliant/sales_tax_rate.rb
+- lib/ship_compliant/search_more_sales_orders.rb
 - lib/ship_compliant/search_sales_order_summary.rb
 - lib/ship_compliant/search_sales_orders.rb
 - lib/ship_compliant/search_sales_orders_result.rb
@@ -268,6 +287,7 @@ files:
 - spec/lib/ship_compliant/product_attributes_spec.rb
 - spec/lib/ship_compliant/product_sales_tax_rate_spec.rb
 - spec/lib/ship_compliant/sales_tax_rate_spec.rb
+- spec/lib/ship_compliant/search_more_sales_orders_spec.rb
 - spec/lib/ship_compliant/search_sales_order_summary_spec.rb
 - spec/lib/ship_compliant/search_sales_orders_result_spec.rb
 - spec/lib/ship_compliant/search_sales_orders_spec.rb
@@ -308,6 +328,7 @@ test_files:
 - features/commit_sales_order.feature
 - features/get_inventory_details.feature
 - features/get_sales_order_extended.feature
+- features/search_more_sales_orders.feature
 - features/search_sales_orders.feature
 - features/step_definitions/brand_steps.rb
 - features/step_definitions/commit_sales_order/all_shipments.rb
@@ -318,6 +339,7 @@ test_files:
 - features/step_definitions/inventory_steps.rb
 - features/step_definitions/product_steps.rb
 - features/step_definitions/sales_order_extended_steps.rb
+- features/step_definitions/search_more_orders_steps.rb
 - features/step_definitions/search_order_steps.rb
 - features/step_definitions/void_order_steps.rb
 - features/support/env.rb
@@ -355,6 +377,7 @@ test_files:
 - spec/lib/ship_compliant/product_attributes_spec.rb
 - spec/lib/ship_compliant/product_sales_tax_rate_spec.rb
 - spec/lib/ship_compliant/sales_tax_rate_spec.rb
+- spec/lib/ship_compliant/search_more_sales_orders_spec.rb
 - spec/lib/ship_compliant/search_sales_order_summary_spec.rb
 - spec/lib/ship_compliant/search_sales_orders_result_spec.rb
 - spec/lib/ship_compliant/search_sales_orders_spec.rb