shopify_api 4.0.6 → 4.0.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 3b420e3a91512cfad9b08b6f73a6a3b1db3980e1
-  data.tar.gz: 5be48b2aafaa9f8185e8e9feb94cb55a593f574a
+  metadata.gz: 8c171c258fbdbd3d55c3d29332ae04332f4712cf
+  data.tar.gz: ae0cc40c73d57a7938195fc1d0bb90af8aeff0b1
 SHA512:
-  metadata.gz: 5e055980f0ba1b5d050b8fa4ca3a15484cafc3daa30ddafecae4d2366df1cb2c67fbb55c214b0da898f5e101dced692a5738b0064fd0a873661a3ad8a222b42b
-  data.tar.gz: 7167cbce2c9a198c4d70ae814ea08a94acc37c5b6e5193b86619f868dfc667121d01eed39ba98fbd89e96ff44aae0661dc9a41c25d9ed6249f17a44235d9f85c
+  metadata.gz: 58ec881bfa5d516de2c9a39aefd1d8278b933f7fffe949e191d451b5b03a55e2afccb4c60c9ff9f4e3965fa30c15fa7b7336d18ad0f5d0510c13030338e81fd5
+  data.tar.gz: 28d02bc796f1ff6dcd56b83a01acfd94ef6aed81bcaef446c2bb4d1d30a0156c5534250f14db4cff2c5d4d7555c8665cbefc68ea4be604acf5a8b9e03e3c0a27

data/CHANGELOG

@@ -1,3 +1,7 @@
+== Version 4.0.7
+
+* Added `ShippingAPI::ShippingZone`
+
 == Version 4.0.6
 
 * Replaced `cancelled` with `expired` in `ShopifyAPI::ApplicationCharge`

data/CONTRIBUTING.md

@@ -0,0 +1,8 @@
+Submitting Issues
+-----------------
+
+Please open an issue here if you encounter a specific bug with this API client library or if something is documented here https://docs.shopify.com/api but is missing from this package.
+
+General questions about the Shopify API and usage of this package (not neccessarily a bug) should be posted on the [Shopify forums](https://ecommerce.shopify.com/c/shopify-apis-and-technology).
+
+When in doubt, post on the forum first. You'll likely have your questions answered more quickly if you post there; more people monitor the forum than Github.

data/README.md

@@ -11,7 +11,7 @@ The API is implemented as JSON over HTTP using all four verbs (GET/POST/PUT/DELE
 
 All API usage happens through Shopify applications, created by either shop owners for their own shops, or by Shopify Partners for use by other shop owners:
 
-* Shop owners can create applications for themselves through their own admin: http://docs.shopify.com/api/tutorials/creating-a-private-app
+* Shop owners can create applications for themselves through their own admin: https://docs.shopify.com/api/authentication/creating-a-private-app
 * Shopify Partners create applications through their admin: http://app.shopify.com/services/partners
 
 For more information and detailed documentation about the API visit http://api.shopify.com
@@ -55,7 +55,8 @@ ShopifyAPI uses ActiveResource to communicate with the REST web service. ActiveR
 
    * ``client_id``– Required – The API key for your app
    * ``scope`` – Required – The list of required scopes (explained here: http://docs.shopify.com/api/tutorials/oauth)
-   * ``redirect_uri`` – Optional – The URL that the merchant will be sent to once authentication is complete. Defaults to the URL specified in the application settings and must be the same host as that URL.
+   * ``redirect_uri`` – Required – The URL where you want to redirect the users after they authorize the client. The complete URL specified here must be identical to one of the Application Redirect URLs set in the App's section of the Partners dashboard. Note: in older applications, this parameter was optional, and redirected to the Application Callback URL when no other value was specified.
+   * ``state`` – Optional – A randomly selected value provided by your application, which is unique for each authorization request. During the OAuth callback phase, your application must check that this value matches the one you provided during authorization. [This mechanism is important for the security of your application](https://tools.ietf.org/html/rfc6819#section-3.6).
 
    We've added the create_permission_url method to make this easier, first instantiate your session object:
 
@@ -76,7 +77,15 @@ ShopifyAPI uses ActiveResource to communicate with the REST web service. ActiveR
    permission_url = session.create_permission_url(scope, "https://my_redirect_uri.com")
    ```
 
-4. Once authorized, the shop redirects the owner to the return URL of your application with a parameter named 'code'. This is a temporary token that the app can exchange for a permanent access token. Make the following call:
+4. Once authorized, the shop redirects the owner to the return URL of your application with a parameter named 'code'. This is a temporary token that the app can exchange for a permanent access token.
+
+   Before you proceed, make sure your application performs the following security checks. If any of the checks fails, your application must reject the request with an error, and must not proceed further.
+
+   * Ensure the provided ``state`` is the same one that your application provided to Shopify during Step 3.
+   * Ensure the provided hmac is valid. The hmac is signed by Shopify as explained below, in the Verification section.
+   * Ensure the provided hostname parameter is a valid hostname, ends with myshopify.com, and does not contain characters other than letters (a-z), numbers (0-9), dots, and hyphens.
+
+   If all security checks pass, the authorization code can be exchanged once for a permanent access token. The exchange is made with a request to the shop.
 
    ```
    POST https://SHOP_NAME.myshopify.com/admin/oauth/access_token
@@ -145,28 +154,34 @@ ShopifyAPI uses ActiveResource to communicate with the REST web service. ActiveR
 
 ### Console
 
-This package also includes the ``shopify`` executable to make it easy to open up an interactive console to use the API with a shop.
+This package also supports the ``shopify-cli`` executable to make it easy to open up an interactive console to use the API with a shop.
+
+1. Install the ``shopify_cli`` gem.
+
+```bash
+gem install shopify_cli
+```
 
-1. Obtain a private API key and password to use with your shop (step 2 in "Getting Started")
+2. Obtain a private API key and password to use with your shop (step 2 in "Getting Started")
 
-2. Use the ``shopify`` script to save the credentials for the shop to quickly log in.
+3. Use the ``shopify-cli`` script to save the credentials for the shop to quickly log in.
 
    ```bash
-   shopify add yourshopname
+   shopify-cli add yourshopname
    ```
 
    Follow the prompts for the shop domain, API key and password.
 
-3. Start the console for the connection.
+4. Start the console for the connection.
 
    ```bash
-   shopify console
+   shopify-cli console
    ```
 
-4. To see the full list of commands, type:
+5. To see the full list of commands, type:
 
    ```bash
-   shopify help
+   shopify-cli help
    ```
 
 ## Threadsafety

data/lib/active_resource/json_errors.rb

@@ -25,7 +25,7 @@ module ActiveResource
     def from_string(error, save_cache = false)
       clear unless save_cache
 
-      add("message", error)
+      add(:base, error)
     end
   end
 end

data/lib/shopify_api/resources/fulfillment_event.rb

@@ -0,0 +1,15 @@
+module ShopifyAPI
+  class FulfillmentEvent < Base
+    self.prefix = '/admin/orders/:order_id/fulfillments/:fulfillment_id/'
+    self.collection_name = 'events'
+    self.element_name = 'event'
+
+    def order_id
+      @prefix_options[:order_id]
+    end
+
+    def fulfillment_id
+      @prefix_options[:fulfillment_id]
+    end
+  end
+end

data/lib/shopify_api/resources/shipping_zone.rb

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

data/lib/shopify_api/session.rb

@@ -16,7 +16,7 @@ module ShopifyAPI
     class << self
 
       def setup(params)
-        params.each { |k,value| send("#{k}=", value) }
+        params.each { |k,value| public_send("#{k}=", value) }
       end
 
       def temp(domain, token, &block)

data/lib/shopify_api/version.rb

@@ -1,3 +1,3 @@
 module ShopifyAPI
-  VERSION = "4.0.6"
+  VERSION = "4.0.7"
 end

data/test/active_resource/json_errors_test.rb

@@ -4,19 +4,16 @@ module ActiveResource
   class JsonErrorsTest < Test::Unit::TestCase
 
     def test_parsing_of_error_json_hash
-      errors = some_error.from_json({errors: {name: ['missing']}}.to_json)
-      assert_equal({"name"=>["missing"]}, errors)
+      @model = ShopifyAPI::Order.new
+      @model.errors.from_json({errors: {name: ['missing']}}.to_json)
+      assert_equal ['missing'], @model.errors[:name]
     end
 
     def test_parsing_of_error_json_plain_string
-      errors = some_error.from_json({errors: 'some generic error'}.to_json)
-      assert_equal(["some generic error"], errors)
-    end
-
-    private
-
-    def some_error
-      ActiveResource::Errors.new(ShopifyAPI::Order.new)
+      @model = ShopifyAPI::Order.new
+      @model.errors.from_json({errors: 'some generic error'}.to_json)
+      assert_equal ['some generic error'], @model.errors[:base]
+      assert_equal 'some generic error', @model.errors.full_messages.to_sentence
     end
   end
 end

data/test/fixtures/fulfillment_event.json

@@ -0,0 +1,12 @@
+{
+  "event": {
+    "created_at": "2013-11-01T16:06:08-04:00",
+    "updated_at": "2013-11-01T16:06:08-04:00",
+    "id": 334455,
+    "fulfillment_id": 255858046,
+    "order_id": 450789469,
+    "status": "in_transit",
+    "happened_at": "2013-11-01T16:06:08-04:00",
+    "estimated_delivery_date": "2013-11-15T18:00:00-04:00"
+  }
+}

data/test/fixtures/shipping_zones.json

@@ -0,0 +1,315 @@
+{
+  "shipping_zones": [
+    {
+      "id": 1,
+      "name": "Canada",
+      "countries": [
+        {
+          "id": 189,
+          "name": "Canada",
+          "tax": 0,
+          "code": "CA",
+          "tax_name": "GST",
+          "provinces": [
+            {
+              "id": 1,
+              "country_id": 189,
+              "name": "Alberta",
+              "code": "AB",
+              "tax": 0,
+              "tax_name": "PST",
+              "tax_type": null,
+              "shipping_zone_id": 1,
+              "tax_percentage": 0
+            },
+            {
+              "id": 2,
+              "country_id": 189,
+              "name": "British Columbia",
+              "code": "BC",
+              "tax": 0,
+              "tax_name": "PST",
+              "tax_type": null,
+              "shipping_zone_id": 1,
+              "tax_percentage": 0
+            },
+            {
+              "id": 9,
+              "country_id": 189,
+              "name": "Ontario",
+              "code": "ON",
+              "tax": 0,
+              "tax_name": "HST",
+              "tax_type": "harmonized",
+              "shipping_zone_id": 1,
+              "tax_percentage": 0
+            },
+            {
+              "id": 11,
+              "country_id": 189,
+              "name": "Quebec",
+              "code": "QC",
+              "tax": 0,
+              "tax_name": "QST",
+              "tax_type": null,
+              "shipping_zone_id": 1,
+              "tax_percentage": 0
+            }
+          ]
+        }
+      ],
+      "weight_based_shipping_rates": [
+        {
+          "id": 1,
+          "weight_low": 0,
+          "weight_high": 55.12,
+          "name": "Lighter items",
+          "price": "10.00",
+          "shipping_zone_id": 1
+        }
+      ],
+      "price_based_shipping_rates": [
+        {
+          "id": 1,
+          "name": "Cheaper items",
+          "min_order_subtotal": "0.00",
+          "price": "100.00",
+          "max_order_subtotal": "50.00",
+          "shipping_zone_id": 1
+        }
+      ],
+      "carrier_shipping_rate_providers": [
+        {
+          "id": 81,
+          "country_id": null,
+          "carrier_service_id": 15,
+          "percent_modifier": 1,
+          "service_filter": {
+            "*": "+"
+          },
+          "flat_modifier": "0.00",
+          "shipping_zone_id": 1
+        },
+        {
+          "id": 454,
+          "country_id": null,
+          "carrier_service_id": 17,
+          "percent_modifier": 0,
+          "service_filter": {
+            "*": "+"
+          },
+          "flat_modifier": "0.00",
+          "shipping_zone_id": 1
+        },
+        {
+          "id": 457,
+          "country_id": null,
+          "carrier_service_id": 21,
+          "percent_modifier": 0,
+          "service_filter": {
+            "*": "+"
+          },
+          "flat_modifier": "0.00",
+          "shipping_zone_id": 1
+        },
+        {
+          "id": 460,
+          "country_id": null,
+          "carrier_service_id": 22,
+          "percent_modifier": 0,
+          "service_filter": {
+            "*": "+"
+          },
+          "flat_modifier": "0.00",
+          "shipping_zone_id": 1
+        }
+      ]
+    },
+    {
+      "id": 2,
+      "name": "US",
+      "countries": [
+        {
+          "id": 190,
+          "name": "United States",
+          "tax": 0,
+          "code": "US",
+          "tax_name": "Federal Tax",
+          "provinces": [
+            {
+              "id": 58,
+              "country_id": 190,
+              "name": "Puerto Rico",
+              "code": "PR",
+              "tax": 0,
+              "tax_name": "State Tax",
+              "tax_type": null,
+              "shipping_zone_id": 2,
+              "tax_percentage": 0
+            },
+            {
+              "id": 67,
+              "country_id": 190,
+              "name": "Washington",
+              "code": "WA",
+              "tax": 0,
+              "tax_name": "State Tax",
+              "tax_type": null,
+              "shipping_zone_id": 2,
+              "tax_percentage": 0
+            },
+            {
+              "id": 70,
+              "country_id": 190,
+              "name": "Wisconsin",
+              "code": "WI",
+              "tax": 0,
+              "tax_name": "State Tax",
+              "tax_type": null,
+              "shipping_zone_id": 2,
+              "tax_percentage": 0
+            },
+            {
+              "id": 71,
+              "country_id": 190,
+              "name": "Wyoming",
+              "code": "WY",
+              "tax": 0,
+              "tax_name": "State Tax",
+              "tax_type": null,
+              "shipping_zone_id": 2,
+              "tax_percentage": 0
+            }
+          ]
+        }
+      ],
+      "weight_based_shipping_rates": [
+        
+      ],
+      "price_based_shipping_rates": [
+        
+      ],
+      "carrier_shipping_rate_providers": [
+        {
+          "id": 455,
+          "country_id": null,
+          "carrier_service_id": 17,
+          "percent_modifier": 0,
+          "service_filter": {
+            "*": "+"
+          },
+          "flat_modifier": "0.00",
+          "shipping_zone_id": 2
+        },
+        {
+          "id": 458,
+          "country_id": null,
+          "carrier_service_id": 21,
+          "percent_modifier": 0,
+          "service_filter": {
+            "*": "+"
+          },
+          "flat_modifier": "0.00",
+          "shipping_zone_id": 2
+        },
+        {
+          "id": 461,
+          "country_id": null,
+          "carrier_service_id": 22,
+          "percent_modifier": 0,
+          "service_filter": {
+            "*": "+"
+          },
+          "flat_modifier": "0.00",
+          "shipping_zone_id": 2
+        },
+        {
+          "id": 475,
+          "country_id": null,
+          "carrier_service_id": 15,
+          "percent_modifier": 0,
+          "service_filter": {
+            "*": "+"
+          },
+          "flat_modifier": "0.00",
+          "shipping_zone_id": 2
+        }
+      ]
+    },
+    {
+      "id": 7,
+      "name": "UK",
+      "countries": [
+        {
+          "id": 195,
+          "name": "United Kingdom",
+          "tax": 0,
+          "code": "GB",
+          "tax_name": "VAT",
+          "provinces": [
+            
+          ]
+        }
+      ],
+      "weight_based_shipping_rates": [
+        
+      ],
+      "price_based_shipping_rates": [
+        {
+          "id": 2,
+          "name": "Some name",
+          "min_order_subtotal": "0.00",
+          "price": "30.00",
+          "max_order_subtotal": "29.99",
+          "shipping_zone_id": 7
+        }
+      ],
+      "carrier_shipping_rate_providers": [
+        {
+          "id": 456,
+          "country_id": null,
+          "carrier_service_id": 17,
+          "percent_modifier": 0,
+          "service_filter": {
+            "*": "+"
+          },
+          "flat_modifier": "0.00",
+          "shipping_zone_id": 7
+        },
+        {
+          "id": 459,
+          "country_id": null,
+          "carrier_service_id": 21,
+          "percent_modifier": 0,
+          "service_filter": {
+            "*": "+"
+          },
+          "flat_modifier": "0.00",
+          "shipping_zone_id": 7
+        },
+        {
+          "id": 462,
+          "country_id": null,
+          "carrier_service_id": 22,
+          "percent_modifier": 0,
+          "service_filter": {
+            "*": "+"
+          },
+          "flat_modifier": "0.00",
+          "shipping_zone_id": 7
+        },
+        {
+          "id": 476,
+          "country_id": null,
+          "carrier_service_id": 15,
+          "percent_modifier": 0,
+          "service_filter": {
+            "*": "+"
+          },
+          "flat_modifier": "0.00",
+          "shipping_zone_id": 7
+        }
+      ]
+    }
+  ]
+}

data/test/fulfillment_event_test.rb

@@ -0,0 +1,69 @@
+require 'test_helper'
+
+class FulFillmentEventTest < Test::Unit::TestCase
+  def test_find_all_resources
+    fake 'orders/450789469/fulfillments/255858046/events',
+         method: :get,
+         body: "[#{load_fixture('fulfillment_event')}]"
+
+    events = ShopifyAPI::FulfillmentEvent.all(
+      params: { fulfillment_id: 255858046, order_id: 450789469 }
+    )
+
+    assert_equal 1, events.count
+  end
+
+  def test_find_a_resource
+    fake 'orders/450789469/fulfillments/255858046/events/334455',
+         method: :get,
+         body: load_fixture('fulfillment_event')
+
+    event = ShopifyAPI::FulfillmentEvent.find(
+      334455, params: { fulfillment_id: 255858046, order_id: 450789469 }
+    )
+
+    assert_equal 'in_transit', event.status
+    assert_equal 255858046, event.fulfillment_id
+    assert_equal 450789469, event.order_id
+  end
+
+  def test_create_a_resource
+    fake 'orders/450789469/fulfillments/255858046/events', method: :post, body: ''
+
+    event = ShopifyAPI::FulfillmentEvent.new(
+      fulfillment_id: 255858046,
+      order_id: 450789469,
+      status: 'in_transit'
+    )
+
+    assert event.save
+  end
+
+  def test_update_a_resource
+    fake 'orders/450789469/fulfillments/255858046/events/334455',
+         method: :get,
+         body: load_fixture('fulfillment_event')
+
+    event = ShopifyAPI::FulfillmentEvent.find(
+      334455, params: { fulfillment_id: 255858046, order_id: 450789469 }
+    )
+
+    fake 'orders/450789469/fulfillments/255858046/events/334455', method: :put, body: ''
+
+    assert event.save
+  end
+
+  def test_destroy_a_resource
+    fake 'orders/450789469/fulfillments/255858046/events/334455',
+         method: :get,
+         body: load_fixture('fulfillment_event')
+
+    event = ShopifyAPI::FulfillmentEvent.find(
+      334455, params: { fulfillment_id: 255858046, order_id: 450789469 }
+    )
+
+    fake 'orders/450789469/fulfillments/255858046/events/334455', method: :delete, body: ''
+
+    assert event.destroy
+  end
+end

data/test/shipping_zone_test.rb

@@ -0,0 +1,10 @@
+require 'test_helper'
+
+class ShippingZoneTest < Test::Unit::TestCase
+  test "get all should get all shipping zones" do
+    fake 'shipping_zones', :method => :get, :status => 200, :body => load_fixture('shipping_zones')
+    checkout = ShopifyAPI::ShippingZone.all
+    assert_equal 1, checkout.first.id
+    assert_equal "Canada", checkout.first.name
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: shopify_api
 version: !ruby/object:Gem::Version
-  version: 4.0.6
+  version: 4.0.7
 platform: ruby
 authors:
 - Shopify
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-08-10 00:00:00.000000000 Z
+date: 2015-11-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activeresource
@@ -110,6 +110,7 @@ files:
 - ".gitignore"
 - ".travis.yml"
 - CHANGELOG
+- CONTRIBUTING.md
 - CONTRIBUTORS
 - Gemfile
 - Gemfile_ar30
@@ -155,6 +156,7 @@ files:
 - lib/shopify_api/resources/customer_saved_search.rb
 - lib/shopify_api/resources/event.rb
 - lib/shopify_api/resources/fulfillment.rb
+- lib/shopify_api/resources/fulfillment_event.rb
 - lib/shopify_api/resources/fulfillment_service.rb
 - lib/shopify_api/resources/gift_card.rb
 - lib/shopify_api/resources/image.rb
@@ -178,6 +180,7 @@ files:
 - lib/shopify_api/resources/script_tag.rb
 - lib/shopify_api/resources/shipping_address.rb
 - lib/shopify_api/resources/shipping_line.rb
+- lib/shopify_api/resources/shipping_zone.rb
 - lib/shopify_api/resources/shop.rb
 - lib/shopify_api/resources/smart_collection.rb
 - lib/shopify_api/resources/tax_line.rb
@@ -218,6 +221,7 @@ files:
 - test/fixtures/customers_search.json
 - test/fixtures/events.json
 - test/fixtures/fulfillment.json
+- test/fixtures/fulfillment_event.json
 - test/fixtures/fulfillment_service.json
 - test/fixtures/gift_card.json
 - test/fixtures/gift_card_disabled.json
@@ -236,6 +240,7 @@ files:
 - test/fixtures/recurring_application_charges.json
 - test/fixtures/script_tag.json
 - test/fixtures/script_tags.json
+- test/fixtures/shipping_zones.json
 - test/fixtures/shop.json
 - test/fixtures/tags.json
 - test/fixtures/transaction.json
@@ -243,6 +248,7 @@ files:
 - test/fixtures/variants.json
 - test/fixtures/webhook.json
 - test/fixtures/webhooks.json
+- test/fulfillment_event_test.rb
 - test/fulfillment_service_test.rb
 - test/fulfillment_test.rb
 - test/gift_card_test.rb
@@ -257,6 +263,7 @@ files:
 - test/recurring_application_charge_test.rb
 - test/script_tag_test.rb
 - test/session_test.rb
+- test/shipping_zone_test.rb
 - test/shop_test.rb
 - test/test_helper.rb
 - test/transaction_test.rb