shopify_api 4.3.0 → 4.3.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: df0d9072de811f85dcd0a3c8dd778d36d32571c3
-  data.tar.gz: 35fcf37d798c2cc92cc960e0bafeeb2514482d15
+  metadata.gz: b71e5318b9970359ed688393a774c332efcfb83b
+  data.tar.gz: fc99b55edc6c8dd8753edfee81d297becac59815
 SHA512:
-  metadata.gz: be971202041dd157e278b3d40920d6c4e37a6dad77b0e1f5dce89c4a1ec14238a609c129ce1c19e0780543b0363527361d7b4908b079d38abec29784845791fb
-  data.tar.gz: 735562487217f0bd86fe5c430dfc08bf258c1c0cba3f0d1da18ea4c0bcb783c96f8dda78baa4cd7b16caf59c980f3e7b0141d7cbe39baef537fbb944ac6da411
+  metadata.gz: fe95b2e5f5747e3f04648b46f626439512cb94722cfeb9d03256a6e5479665d25f64eeb2b31e25202e80dc0f7458b338ebc3599722e9d34def4f4cb32424360d
+  data.tar.gz: 2f5339e68a4670396810a72c20d49c1e4bea4a5a531e3b48950d8386c167a109792c3be9258f4366f5ee187a0cc8765837b673844c23fff7f83232af67c420d7

data/CHANGELOG

@@ -1,3 +1,7 @@
+== Version 4.3.1
+
+* Support for ShopifyAPI::ApplicationCredit
+
 == Version 4.3.0
 
 * Require Ruby >= `2.3.0`

data/README.md

@@ -1,5 +1,10 @@
-[![Build Status](https://travis-ci.org/Shopify/shopify_api.svg?branch=master)](https://travis-ci.org/Shopify/shopify_api)
-# Shopify API
+Shopify API
+===========
+[![Version][gem]][gem_url] [![Build Status](https://travis-ci.org/Shopify/shopify_api.svg?branch=master)](https://travis-ci.org/Shopify/shopify_api)
+
+[gem]: https://img.shields.io/gem/v/shopify_api.svg
+[gem_url]: https://rubygems.org/gems/shopify_api
+
 
 The Shopify API gem allows Ruby developers to programmatically access the admin section of Shopify stores.
 
@@ -22,12 +27,27 @@ This gem requires Ruby 2.3.1 as of version 4.3. If you need to use an older Ruby
 
 ### Installation
 
-To easily install or upgrade to the latest release, use [gem](http://rubygems.org/)
+Add `shopify_api` to your `Gemfile`:
+
+```ruby
+gem 'shopify_api'
+```
+
+Or install via [gem](http://rubygems.org/)
 
 ```bash
 gem install shopify_api
 ```
 
+#### Rails 5
+
+shopify_api is compatible with Rails 5 but since the latest ActiveResource release (4.1) is locked on Rails 4.x, you'll need to use the unreleased master version:
+
+```ruby
+gem 'shopify_api'
+gem 'activeresource', github: 'rails/activeresource'
+```
+
 ### Getting Started
 
 ShopifyAPI uses ActiveResource to communicate with the REST web service. ActiveResource has to be configured with a fully authorized URL of a particular store first. To obtain that URL you can follow these steps:

data/lib/active_resource/connection_ext.rb

@@ -1,32 +1,10 @@
+require 'shopify_api/connection'
+
 module ActiveResource
   class Connection
     attr_reader :response
 
-    module ResponseCapture
-      def handle_response(response)
-        @response = super
-      end
-    end
-
-    module RequestNotification
-      def request(method, path, *arguments)
-        super.tap do |response|
-          notify_about_request(response, arguments)
-        end
-      rescue => e
-        notify_about_request(e.response, arguments) if e.respond_to?(:response)
-        raise
-      end
-
-      def notify_about_request(response, arguments)
-        ActiveSupport::Notifications.instrument("request.active_resource_detailed") do |payload|
-          payload[:response] = response
-          payload[:data]     = arguments
-        end
-      end
-    end
-
-    prepend ResponseCapture
-    prepend RequestNotification
+    prepend ShopifyAPI::Connection::ResponseCapture
+    prepend ShopifyAPI::Connection::RequestNotification
   end
 end

data/lib/active_resource/disable_prefix_check.rb

@@ -12,7 +12,7 @@ module DisablePrefixCheck
 
       init_prefix_explicit resource_type, resource_id
 
-      define_singleton_method :prefix do |options|
+      define_singleton_method :prefix do |options = {}|
         resource_type =  options[resource] if flexible
 
         options[resource_id].nil? ? "/admin/" : "/admin/#{resource_type}/#{options[resource_id]}/"

data/lib/shopify_api.rb

@@ -4,7 +4,6 @@ require 'active_resource'
 require 'active_support/core_ext/class/attribute_accessors'
 require 'digest/md5'
 require 'base64'
-require 'active_resource/connection_ext'
 require 'active_resource/detailed_log_subscriber'
 require 'shopify_api/limits'
 require 'shopify_api/json_format'
@@ -22,3 +21,10 @@ require 'shopify_api/metafields'
 require 'shopify_api/countable'
 require 'shopify_api/resources'
 require 'shopify_api/session'
+require 'shopify_api/connection'
+
+if ShopifyAPI::Base.respond_to?(:connection_class)
+  ShopifyAPI::Base.connection_class = ShopifyAPI::Connection
+else
+  require 'active_resource/connection_ext'
+end

data/lib/shopify_api/connection.rb

@@ -0,0 +1,33 @@
+module ShopifyAPI
+  class Connection < ActiveResource::Connection
+    attr_reader :response
+
+    module ResponseCapture
+      def handle_response(response)
+        @response = super
+      end
+    end
+
+    include ResponseCapture
+
+    module RequestNotification
+      def request(method, path, *arguments)
+        super.tap do |response|
+          notify_about_request(response, arguments)
+        end
+      rescue => e
+        notify_about_request(e.response, arguments) if e.respond_to?(:response)
+        raise
+      end
+
+      def notify_about_request(response, arguments)
+        ActiveSupport::Notifications.instrument("request.active_resource_detailed") do |payload|
+          payload[:response] = response
+          payload[:data]     = arguments
+        end
+      end
+    end
+
+    include RequestNotification
+  end
+end

data/lib/shopify_api/countable.rb

@@ -1,7 +1,14 @@
 module ShopifyAPI
   module Countable
     def count(options = {})
-      Integer(get(:count, options))
+      data = get(:count, options)
+
+      count = case data
+        when Hash then data["count"]
+        else data
+      end
+
+      Integer(count)
     end
   end
 end

data/lib/shopify_api/resources/application_credit.rb

@@ -0,0 +1,4 @@
+module ShopifyAPI
+  class ApplicationCredit < Base
+  end
+end

data/lib/shopify_api/resources/fulfillment_request.rb

@@ -0,0 +1,15 @@
+module ShopifyAPI
+  class FulfillmentRequest < Base
+    init_prefix :order
+
+    def order_id
+      @prefix_options[:order_id]
+    end
+
+    def mark_as_failed
+      load_attributes_from_response(
+        put(:mark_as_failed, message: failure_message)
+      )
+    end
+  end
+end

data/lib/shopify_api/version.rb

@@ -1,3 +1,3 @@
 module ShopifyAPI
-  VERSION = "4.3.0"
+  VERSION = "4.3.1"
 end

data/test/application_credit_test.rb

@@ -0,0 +1,35 @@
+require 'test_helper'
+
+class ApplicationCreditTest < Test::Unit::TestCase
+  def test_application_credit_create
+    fake "application_credits", method: :post, status: 201, body: load_fixture('application_credit')
+
+    credit = ShopifyAPI::ApplicationCredit.create(
+      description: "refund for application charge",
+      amount: 5.00,
+      api_client_id: 861378,
+      shop_id: 487168
+    )
+
+    assert_equal 'refund for application charge', credit.description
+    assert_equal '5.00', credit.amount
+  end
+
+  def test_get_application_credit
+    fake "application_credits/803742", method: :get, status: 201, body: load_fixture('application_credit')
+
+    credit = ShopifyAPI::ApplicationCredit.find(803742)
+
+    assert_equal 'refund for application charge', credit.description
+    assert_equal '5.00', credit.amount
+  end
+
+  def test_list_application_credits
+    fake "application_credits", method: :get, status: 201, body: load_fixture('application_credits')
+
+    credit = ShopifyAPI::ApplicationCredit.find(:all)
+
+    assert_equal 2, credit.size
+    assert_equal '10.00', credit.last.amount
+  end
+end

data/test/countable_test.rb

@@ -0,0 +1,12 @@
+require 'test_helper'
+
+class CountableTest < Test::Unit::TestCase
+  def setup
+    fake "products/count", :body => '{"count": 16}'
+  end
+
+  def test_count_products
+    count = ShopifyAPI::Product.count
+    assert_equal 16, count
+  end
+end

data/test/fixtures/application_credit.json

@@ -0,0 +1,12 @@
+{
+  "application_credit": {
+    "id": 803742,
+    "api_client_id": 861378,
+    "partner_id": 549861,
+    "shop_id": 487168,
+    "amount": "5.00",
+    "description": "refund for application charge",
+    "created_at": "2015-07-10T15:03:51+10:00",
+    "updated_at": "2015-07-10T15:03:51+10:00"
+  }
+}

data/test/fixtures/application_credits.json

@@ -0,0 +1,24 @@
+{
+  "application_charges": [
+    {
+      "id": 803742,
+      "api_client_id": 861378,
+      "shop_id": 487168,
+      "amount": "5.00",
+      "billing_status": "pending",
+      "description": "refund for application charge",
+      "created_at": "2015-07-10T15:03:51+10:00",
+      "updated_at": "2015-07-10T15:03:51+10:00"
+    },
+    {
+      "id": 803743,
+      "api_client_id": 861378,
+      "shop_id": 487168,
+      "amount": "10.00",
+      "billing_status": "pending",
+      "description": "refund for application charge",
+      "created_at": "2015-07-10T15:03:51+10:00",
+      "updated_at": "2015-07-10T15:03:51+10:00"
+    }
+  ]
+}

data/test/fixtures/fulfillment_request.json

@@ -0,0 +1,28 @@
+{
+   "fulfillment_request":{
+      "id":695890229,
+      "shop_id":690933842,
+      "order_id":450789469,
+      "fulfillment_service_id":755357713,
+      "service_handle":"shipwire-app",
+      "delivered_at":null,
+      "failed_at":null,
+      "failure_message":null,
+      "receipt":null,
+      "is_not_deleted":true,
+      "deleted_at":null,
+      "created_at":"2016-07-12T11:23:42-04:00",
+      "updated_at":"2016-07-12T11:23:42-04:00",
+      "fulfillment_request_line_items":[
+         {
+            "id":6,
+            "shop_id":690933842,
+            "fulfillment_request_id":695890229,
+            "line_item_id":466157049,
+            "quantity":1,
+            "created_at":"2016-07-12T11:23:54-04:00",
+            "updated_at":"2016-07-12T11:23:54-04:00"
+         }
+      ]
+   }
+}

data/test/fulfillment_request_test.rb

@@ -0,0 +1,29 @@
+require 'test_helper'
+
+class FulFillmentRequestTest < Test::Unit::TestCase
+  def setup
+    fake "orders/450789469/fulfillment_requests/695890229", method: :get, body: load_fixture('fulfillment_request')
+  end
+
+  context "#mark_as_failed" do
+    should "be able to mark_as_failed a fulfillment request" do
+      fulfillment_request = ShopifyAPI::FulfillmentRequest.find(255858046, params: { order_id: 450789469 })
+
+      cancelled = ActiveSupport::JSON.decode(load_fixture('fulfillment_request'))
+      cancelled['failure_message'] = 'failure reason'
+      fake "orders/450789469/fulfillment_requests/695890229/mark_as_failed", method: :put, body: ActiveSupport::JSON.encode(cancelled)
+
+      assert fulfillment_request.failure_message.blank?
+      assert fulfillment_request.mark_as_failed
+      assert_equal 'failure reason', fulfillment_request.failure_message
+    end
+  end
+
+  context "#find" do
+    should "be able to find fulfillment request" do
+      fulfillment_request = ShopifyAPI::FulfillmentRequest.find(255858046, params: { order_id: 450789469 })
+      assert_equal 695890229, fulfillment_request.id
+      assert_equal 450789469, fulfillment_request.order_id
+    end
+  end
+end

data/test/refund_test.rb

@@ -9,7 +9,7 @@ class RefundTest < Test::Unit::TestCase
       :restock => true,
       :note => "wrong size",
       :shipping => { :full_refund => true },
-      :refund_line_items => [{ :line_item => 518995019, :quantity => 1 }]
+      :refund_line_items => [{ :line_item_id => 518995019, :quantity => 1 }]
     )
     assert_equal 703073504, refund.refund_line_items.first.line_item_id
   end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: shopify_api
 version: !ruby/object:Gem::Version
-  version: 4.3.0
+  version: 4.3.1
 platform: ruby
 authors:
 - Shopify
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-07-07 00:00:00.000000000 Z
+date: 2016-09-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activeresource
@@ -130,6 +130,7 @@ files:
 - lib/active_resource/json_errors.rb
 - lib/active_resource/to_query.rb
 - lib/shopify_api.rb
+- lib/shopify_api/connection.rb
 - lib/shopify_api/countable.rb
 - lib/shopify_api/events.rb
 - lib/shopify_api/json_format.rb
@@ -140,6 +141,7 @@ files:
 - lib/shopify_api/resources/address.rb
 - lib/shopify_api/resources/announcement.rb
 - lib/shopify_api/resources/application_charge.rb
+- lib/shopify_api/resources/application_credit.rb
 - lib/shopify_api/resources/article.rb
 - lib/shopify_api/resources/asset.rb
 - lib/shopify_api/resources/base.rb
@@ -159,6 +161,7 @@ files:
 - lib/shopify_api/resources/event.rb
 - lib/shopify_api/resources/fulfillment.rb
 - lib/shopify_api/resources/fulfillment_event.rb
+- lib/shopify_api/resources/fulfillment_request.rb
 - lib/shopify_api/resources/fulfillment_service.rb
 - lib/shopify_api/resources/gift_card.rb
 - lib/shopify_api/resources/image.rb
@@ -201,6 +204,7 @@ files:
 - test/access_token_test.rb
 - test/active_resource/json_errors_test.rb
 - test/application_charge_test.rb
+- test/application_credit_test.rb
 - test/article_test.rb
 - test/asset_test.rb
 - test/base_test.rb
@@ -209,6 +213,7 @@ files:
 - test/cart_test.rb
 - test/checkouts_test.rb
 - test/collect_test.rb
+- test/countable_test.rb
 - test/custom_collection_test.rb
 - test/customer_saved_search_test.rb
 - test/customer_test.rb
@@ -217,6 +222,8 @@ files:
 - test/fixtures/access_token_delegate.json
 - test/fixtures/application_charge.json
 - test/fixtures/application_charges.json
+- test/fixtures/application_credit.json
+- test/fixtures/application_credits.json
 - test/fixtures/article.json
 - test/fixtures/articles.json
 - test/fixtures/asset.json
@@ -240,6 +247,7 @@ files:
 - test/fixtures/events.json
 - test/fixtures/fulfillment.json
 - test/fixtures/fulfillment_event.json
+- test/fixtures/fulfillment_request.json
 - test/fixtures/fulfillment_service.json
 - test/fixtures/gift_card.json
 - test/fixtures/gift_card_disabled.json
@@ -276,6 +284,7 @@ files:
 - test/fixtures/webhook.json
 - test/fixtures/webhooks.json
 - test/fulfillment_event_test.rb
+- test/fulfillment_request_test.rb
 - test/fulfillment_service_test.rb
 - test/fulfillment_test.rb
 - test/gift_card_test.rb
@@ -323,7 +332,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.2.3
+rubygems_version: 2.5.1
 signing_key: 
 specification_version: 4
 summary: ShopifyAPI is a lightweight gem for accessing the Shopify admin REST web