shopify_api 3.1.2 → 3.1.3

data/CHANGELOG

@@ -1,3 +1,7 @@
+== Version 3.1.3
+
+* Expose `complete` action on Fulfillment
+
 == Version 3.1.2
 
 * Includes port in domain URI (when other than http/80 or https/443)

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    shopify_api (3.1.2)
+    shopify_api (3.1.3)
       activeresource (>= 3.0.0)
       thor (>= 0.14.4)
 

data/lib/shopify_api/limits.rb

@@ -1,9 +1,11 @@
 module ShopifyAPI
   module Limits
+    class LimitUnavailable < StandardError; end
+
     def self.included(klass)
       klass.send(:extend, ClassMethods)
     end
-    
+
     module ClassMethods
 
       # Takes form num_requests_executed/max_requests
@@ -20,7 +22,7 @@ module ShopifyAPI
         credit_limit(:shop) - credit_used(:shop)
       end
       alias_method :available_calls, :credit_left
-      
+
       ##
       # Have I reached my API call limit?
       # @return {Boolean}
@@ -29,7 +31,7 @@ module ShopifyAPI
         credit_left <= 0
       end
       alias_method :maxed?, :credit_maxed?
-      
+
       ##
       # How many total API calls can I make?
       # NOTE: subtracting 1 from credit_limit because I think ShopifyAPI cuts off at 299 or shop limits.
@@ -38,7 +40,7 @@ module ShopifyAPI
       #
       def credit_limit(scope=:shop)
         @api_credit_limit ||= {}
-        @api_credit_limit[scope] ||= api_credit_limit_param(scope).pop.to_i - 1     
+        @api_credit_limit[scope] ||= api_credit_limit_param(scope).pop.to_i - 1
       end
       alias_method :call_limit, :credit_limit
 
@@ -51,7 +53,7 @@ module ShopifyAPI
         api_credit_limit_param(scope).shift.to_i
       end
       alias_method :call_count, :credit_used
-      
+
       ##
       # @return {HTTPResonse}
       #
@@ -65,9 +67,11 @@ module ShopifyAPI
       ##
       # @return {Array}
       #
-      def api_credit_limit_param(scope)    
-        response[CREDIT_LIMIT_HEADER_PARAM[scope]].split('/')
-      end    
+      def api_credit_limit_param(scope)
+        header = response[CREDIT_LIMIT_HEADER_PARAM[scope]]
+        raise LimitUnavailable unless header
+        header.split('/')
+      end
     end
   end
 end

data/lib/shopify_api/resources/fulfillment.rb

@@ -3,5 +3,6 @@ module ShopifyAPI
     self.prefix = "/admin/orders/:order_id/"
 
     def cancel; load_attributes_from_response(post(:cancel, {}, only_id)); end
+    def complete; load_attributes_from_response(post(:complete, {}, only_id)); end
   end
 end

data/lib/shopify_api/version.rb

@@ -1,3 +1,3 @@
 module ShopifyAPI
-  VERSION = "3.1.2"
+  VERSION = "3.1.3"
 end

data/test/fixtures/fulfillment.json

@@ -0,0 +1,49 @@
+{
+  "fulfillment": {
+    "created_at": "2013-11-01T16:06:08-04:00",
+    "id": 255858046,
+    "order_id": 450789469,
+    "service": "manual",
+    "status": "pending",
+    "tracking_company": null,
+    "updated_at": "2013-11-01T16:06:08-04:00",
+    "tracking_number": "1Z2345",
+    "tracking_numbers": [
+      "1Z2345"
+    ],
+    "tracking_url": "http://www.google.com/search?q=1Z2345",
+    "tracking_urls": [
+      "http://www.google.com/search?q=1Z2345"
+    ],
+    "receipt": {
+      "testcase": true,
+      "authorization": "123456"
+    },
+    "line_items": [
+      {
+        "fulfillment_service": "manual",
+        "fulfillment_status": null,
+        "grams": 200,
+        "id": 466157049,
+        "price": "199.00",
+        "product_id": 632910392,
+        "quantity": 1,
+        "requires_shipping": true,
+        "sku": "IPOD2008GREEN",
+        "title": "IPod Nano - 8gb",
+        "variant_id": 39072856,
+        "variant_title": "green",
+        "vendor": null,
+        "name": "IPod Nano - 8gb - green",
+        "variant_inventory_management": "shopify",
+        "properties": [
+          {
+            "name": "Custom Engraving",
+            "value": "Happy Birthday"
+          }
+        ],
+        "product_exists": true
+      }
+    ]
+  }
+}

data/test/fulfillment_test.rb

@@ -0,0 +1,38 @@
+require 'test_helper'
+
+class FulFillmentTest < Test::Unit::TestCase
+  def setup
+    fake "orders/450789469/fulfillments/255858046", :method => :get, :body => load_fixture('fulfillment')
+  end
+
+  context "Fulfillment" do
+    context "#complete" do
+      should "be able to complete fulfillment" do
+        fulfillment = ShopifyAPI::Fulfillment.find(255858046, :params => {:order_id => 450789469})
+
+        success = ActiveSupport::JSON.decode(load_fixture('fulfillment'))
+        success['fulfillment']['status'] = 'success'
+        fake "orders/450789469/fulfillments/255858046/complete", :method => :post, :body => ActiveSupport::JSON.encode(success)
+
+        assert_equal 'pending', fulfillment.status
+        assert fulfillment.complete
+        assert_equal 'success', fulfillment.status
+      end
+    end
+
+    context "#cancel" do
+      should "be able to cancel fulfillment" do
+        fulfillment = ShopifyAPI::Fulfillment.find(255858046, :params => {:order_id => 450789469})
+
+        cancelled = ActiveSupport::JSON.decode(load_fixture('fulfillment'))
+        cancelled['fulfillment']['status'] = 'cancelled'
+        fake "orders/450789469/fulfillments/255858046/cancel", :method => :post, :body => ActiveSupport::JSON.encode(cancelled)
+
+        assert_equal 'pending', fulfillment.status
+        assert fulfillment.cancel
+        assert_equal 'cancelled', fulfillment.status
+      end
+    end
+  end
+
+end

data/test/limits_test.rb

@@ -7,25 +7,33 @@ class LimitsTest < Test::Unit::TestCase
     @header_hash = {'http_x_shopify_shop_api_call_limit' => '100/300'}
     ShopifyAPI::Base.connection.expects(:response).at_least(0).returns(@header_hash)
   end
-  
+
   context "Limits" do
     should "fetch limit total" do
       assert_equal(299, ShopifyAPI.credit_limit(:shop))
     end
-    
+
     should "fetch used calls" do
       assert_equal(100, ShopifyAPI.credit_used(:shop))
     end
-    
+
     should "calculate remaining calls" do
       assert_equal(199, ShopifyAPI.credit_left)
     end
-    
+
     should "flag maxed out credits" do
       assert !ShopifyAPI.maxed?
       @header_hash = {'http_x_shopify_shop_api_call_limit' => '299/300'}
       ShopifyAPI::Base.connection.expects(:response).at_least(1).returns(@header_hash)
       assert ShopifyAPI.maxed?
     end
+
+    should "raise error when header doesn't exist" do
+      @header_hash = {}
+      ShopifyAPI::Base.connection.expects(:response).at_least(1).returns(@header_hash)
+      assert_raise ShopifyAPI::Limits::LimitUnavailable do
+        ShopifyAPI.credit_left
+      end
+    end
   end
 end

metadata

@@ -1,18 +1,20 @@
 --- !ruby/object:Gem::Specification
 name: shopify_api
 version: !ruby/object:Gem::Version
-  version: 3.1.2
+  version: 3.1.3
+  prerelease: 
 platform: ruby
 authors:
 - Shopify
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-10-29 00:00:00.000000000 Z
+date: 2013-11-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activeresource
   requirement: !ruby/object:Gem::Requirement
+    none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
@@ -20,6 +22,7 @@ dependencies:
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
+    none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
@@ -27,6 +30,7 @@ dependencies:
 - !ruby/object:Gem::Dependency
   name: thor
   requirement: !ruby/object:Gem::Requirement
+    none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
@@ -34,6 +38,7 @@ dependencies:
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
+    none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
@@ -41,6 +46,7 @@ dependencies:
 - !ruby/object:Gem::Dependency
   name: mocha
   requirement: !ruby/object:Gem::Requirement
+    none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
@@ -48,6 +54,7 @@ dependencies:
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
+    none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
@@ -55,6 +62,7 @@ dependencies:
 - !ruby/object:Gem::Dependency
   name: fakeweb
   requirement: !ruby/object:Gem::Requirement
+    none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
@@ -62,6 +70,7 @@ dependencies:
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
+    none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
@@ -69,6 +78,7 @@ dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
+    none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
@@ -76,6 +86,7 @@ dependencies:
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
+    none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
@@ -181,12 +192,14 @@ files:
 - test/fixtures/customer_saved_search.json
 - test/fixtures/customer_saved_search_customers.json
 - test/fixtures/events.json
+- test/fixtures/fulfillment.json
 - test/fixtures/metafield.json
 - test/fixtures/metafields.json
 - test/fixtures/product.json
 - test/fixtures/shop.json
 - test/fixtures/variant.json
 - test/fixtures/variants.json
+- test/fulfillment_test.rb
 - test/limits_test.rb
 - test/order_test.rb
 - test/product_test.rb
@@ -197,27 +210,34 @@ files:
 homepage: http://www.shopify.com/partners/apps
 licenses:
 - MIT
-metadata: {}
 post_install_message: 
 rdoc_options:
 - --charset=UTF-8
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
   requirements:
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
+      segments:
+      - 0
+      hash: -273779937676150409
 required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
   requirements:
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
+      segments:
+      - 0
+      hash: -273779937676150409
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.1.5
+rubygems_version: 1.8.23
 signing_key: 
-specification_version: 4
+specification_version: 3
 summary: ShopifyAPI is a lightweight gem for accessing the Shopify admin REST web
   services
 test_files: []

checksums.yaml

@@ -1,15 +0,0 @@
----
-!binary "U0hBMQ==":
-  metadata.gz: !binary |-
-    Yjk3NThmNmE5YjE3NjgyNTBkNjQ0MmY0MDQ4MmJkN2YwZGMyZWU3MQ==
-  data.tar.gz: !binary |-
-    NDlhZjI5MGZmNTM0ZTlmOGE4ODY4YTFmYjQ5OTAyMGYxY2Y2NTBiOQ==
-SHA512:
-  metadata.gz: !binary |-
-    NjIzNTA3MmZkZTllOWJiMGZhYWI3NWYwZDliNWJiYTNlM2NhYTI0MDQ1MzQ5
-    MWYzZTRjNjM4NzJjNzliOWEzMGYzNTA1NmFkNGM0YjY2NDhhYjNiYzZkODNl
-    NDkzNzVjNjcxY2E2YmY1NzM3YjQxZmI0YzcwNmNlOWExNTRmZjg=
-  data.tar.gz: !binary |-
-    YjlkODc5YjJjNDg3Nzk0NzkyZWJmYzBiZDg1N2RhOTgwYzYzOTk0NDEwOGU3
-    ZTI5YjBkMDNkZjk5MjE3NjNhN2ZhNGE2ZGJmM2YxMGE2YzRiOTA0N2JlYmZk
-    YzAzZWZkM2E2ZTYwYzQ2ZjVlYWNmMDdhMDRhNzk5ZDBlZWM0ZDY=