shopify_api 3.2.5 → 3.2.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 1febe6e195154bd62771f2b8fc00410db6af76d9
-  data.tar.gz: 922a39a6929f9f451d377d9c4133134dc1f6bea2
+  metadata.gz: b1e5927ed74df0622bc45489339508c57b37eb21
+  data.tar.gz: b627aaacb19ff2af728755054308c4508fb65bcd
 SHA512:
-  metadata.gz: f7e8850c60cc4dafe98276923dd472db045db886bd07498fbde719ca0e2f5ff2cb224c0023bc36058e600821a74010927e7e6c07c14fb6134e68ece14d13b5ad
-  data.tar.gz: 7518d576598f7056e3e637256448a4599f6b753a9e9d8ad3af67ed10223bc9d22bb65efe6da5e99e43eab28defd25291c8b3c44bed249f2f6a1d146502a6ca47
+  metadata.gz: 1bfee60f5326d52653166545615a09e15e9ecd498aae0a5c0e4e14d1b385b9d739525baf9279d6cdf6189c91d04c00266aabdbc7cc8efa7c6b385ebe18ec88be
+  data.tar.gz: a7a02acd9edd9fdba3a8f2d71df4685ef338aeca9f098c2c08e66ec4a4d0638ee5983e1989530d253ba9c2dea5c5cf536b9beb9a9c9c81f95f106b846d846fe3

checksums.yaml.gz.sig

@@ -1,3 +1,2 @@
-J���x����&��b�|�Q��ߚ0�p��j���vp2�mA
���(�E��f!�X�IomO���X1'�U��<����6���MH��zJ���&;�����b����2� ��!���C
-���^a���\¿=���k
-P�„>�2��	���.�꜑)����4��#���Q�iS�1!}z�{�6��O�u|��烅9����mhfZ~L�6J������h�F2_3$f�J��^}�~�(MP�
+\|�> P��Z��&�1�1#�x,Z�>���HOHN�������!���1H9W�c���H����b��qb����숅���H�Y��YRoO�[�|��Il�BE鹣5�f<Ex�R 
+���\����h�ݷ�e2'W�YW���50� �gBBC��nR����(������G9�e(�<�l����i�����%�;�"3��i�G��5��#�MT��5�k�r�CDJ3����X��7�ڗ��	

data/.travis.yml

@@ -11,7 +11,7 @@ gemfile:
   - Gemfile_ar32
   - Gemfile_ar40threadsafe
 
-install: bundle install
+sudo: false
 
 before_script: echo $OLD_RAKE
 

data/CHANGELOG

@@ -1,3 +1,7 @@
+== 3.2.6 (Unreleased)
+
+* Fixed CustomerSavedSearch#customers method to now correctly return only relevant customers
+
 == Version 3.2.5
 
 * More useful error messages for activating nil sessions

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    shopify_api (3.2.5)
+    shopify_api (3.2.6)
       activeresource (>= 3.0.0)
       pry (>= 0.9.12.6)
       thor (~> 0.18.1)

data/Gemfile_ar40threadsafe

@@ -3,3 +3,5 @@ source "https://rubygems.org"
 gemspec
 
 gem 'activeresource', :git => 'git://github.com/Shopify/activeresource', :ref => 'e9dc76b4aa'
+
+gem 'minitest', "~> 4.2"

data/README.md

@@ -0,0 +1,201 @@
+[![Build Status](https://travis-ci.org/Shopify/shopify_api.svg?branch=master)](https://travis-ci.org/Shopify/shopify_api)
+# Shopify API
+
+The Shopify API gem allows Ruby developers to programmatically access the admin section of Shopify stores.
+
+The API is implemented as JSON over HTTP using all four verbs (GET/POST/PUT/DELETE). Each resource, like Order, Product, or Collection, has its own URL and is manipulated in isolation. In other words, we’ve tried to make the API follow the REST principles as much as possible.
+
+## Usage
+
+### Requirements
+
+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
+* 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
+
+### Installation
+
+To easily install or upgrade to the latest release, use [gem](http://rubygems.org/)
+
+```bash
+gem install shopify_api
+```
+
+### 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:
+
+1. First create a new application in either the partners admin or your store admin. For a private App you'll need the API_KEY and the PASSWORD otherwise you'll need the API_KEY and SHARED_SECRET.
+
+2. For a private App you just need to set the base site url as follows:
+
+   ```ruby
+   shop_url = "https://#{API_KEY}:#{PASSWORD}@SHOP_NAME.myshopify.com/admin"
+   ShopifyAPI::Base.site = shop_url
+   ```
+
+   That's it, you're done, skip to step 6 and start using the API!
+
+   For a partner app you will need to supply two parameters to the Session class before you instantiate it:
+
+  ```ruby
+  ShopifyAPI::Session.setup({:api_key => API_KEY, :secret => SHARED_SECRET})
+  ```
+
+3. In order to access a shop's data, apps need an access token from that specific shop. This is a two-stage process. Before interacting with a shop for the first time an app should redirect the user to the following URL:
+
+   ```
+   GET https://SHOP_NAME.myshopify.com/admin/oauth/authorize
+   ```
+
+   with the following parameters:
+
+   * ``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.
+
+   We've added the create_permission_url method to make this easier, first instantiate your session object:
+
+   ```ruby
+   session = ShopifyAPI::Session.new("SHOP_NAME.myshopify.com")
+   ```
+
+   Then call:
+
+   ```ruby
+   scope = ["write_products"]
+   permission_url = session.create_permission_url(scope)
+   ```
+
+   or if you want a custom redirect_uri:
+
+   ```ruby
+   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:
+
+   ```
+   POST https://SHOP_NAME.myshopify.com/admin/oauth/access_token
+   ```
+
+   with the following parameters:
+
+   * ``client_id`` – Required – The API key for your app
+   * ``client_secret`` – Required – The shared secret for your app
+   * ``code`` – Required – The token you received in step 3
+
+   and you'll get your permanent access token back in the response.
+
+   There is a method to make the request and get the token for you. Pass
+   all the params received from the previous call and the method will verify
+   the params, extract the temp code and then request your token:
+
+   ```ruby
+   token = session.request_token(params)
+   ```
+
+   This method will save the token to the session object and return it. For future sessions simply pass the token in when creating the session object:
+
+   ```ruby
+   session = ShopifyAPI::Session.new("SHOP_NAME.myshopify.com", token)
+   ```
+
+5. The session must be activated before use:
+
+   ```ruby
+   ShopifyAPI::Base.activate_session(session)
+   ```
+
+6. Now you're ready to make authorized API requests to your shop! Data is returned as ActiveResource instances:
+
+   ```ruby
+   shop = ShopifyAPI::Shop.current
+
+   # Get a specific product
+   product = ShopifyAPI::Product.find(179761209)
+
+   # Create a new product
+   new_product = ShopifyAPI::Product.new
+   new_product.title = "Burton Custom Freestlye 151"
+   new_product.product_type = "Snowboard"
+   new_product.vendor = "Burton"
+   new_product.save
+
+   # Update a product
+   product.handle = "burton-snowboard"
+   product.save
+   ```
+
+   Alternatively, you can use #temp to initialize a Session and execute a command which also handles temporarily setting ActiveResource::Base.site:
+
+   ```ruby
+   products = ShopifyAPI::Session.temp("SHOP_NAME.myshopify.com", token) { ShopifyAPI::Product.find(:all) }
+   ```
+
+7. If you want to work with another shop, you'll first need to clear the session:
+
+   ```ruby
+   ShopifyAPI::Base.clear_session
+   ```
+
+
+### 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.
+
+1. 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.
+
+   ```bash
+   shopify add yourshopname
+   ```
+
+   Follow the prompts for the shop domain, API key and password.
+
+3. Start the console for the connection.
+
+   ```bash
+   shopify console
+   ```
+
+4. To see the full list of commands, type:
+
+   ```bash
+   shopify help
+   ```
+
+## Threadsafety
+
+ActiveResource is inherently non-threadsafe, because class variables like ActiveResource::Base.site and ActiveResource::Base.headers are shared between threads. This can cause conflicts when using threaded libraries, like Sidekiq.
+
+We have a forked version of ActiveResource that stores these class variables in threadlocal variables. Using this forked version will allow ShopifyAPI to be used in a threaded environment.
+
+To enable threadsafety with ShopifyAPI, add the following to your Gemfile:
+
+```
+gem 'activeresource', git: 'git://github.com/Shopify/activeresource', branch: 'threadsafe'
+gem 'shopify_api', '>= 3.2.1'
+```
+
+## Using Development Version
+
+Download the source code and run:
+
+```bash
+rake install
+```
+
+## Additional Resources
+
+API Docs: http://docs.shopify.com/api
+
+Ask questions on the forums: http://ecommerce.shopify.com/c/shopify-apis-and-technology
+
+## Copyright
+
+Copyright (c) 2014 "Shopify Inc.". See LICENSE for details.

data/lib/shopify_api/cli.rb

@@ -27,7 +27,7 @@ module ShopifyAPI
         config['domain']   = ask("Domain? (leave blank for #{connection}.myshopify.com)")
         config['domain']   = "#{connection}.myshopify.com" if config['domain'].blank?
         config['domain']   = "#{config['domain']}.myshopify.com" unless config['domain'].match(/[.:]/)
-        puts "\nopen https://#{config['domain']}/admin/api in your browser to get API credentials\n"
+        puts "\nopen https://#{config['domain']}/admin/apps/private in your browser to create a private app and get API credentials\n"
         config['api_key']  = ask("API key?")
         config['password'] = ask("Password?")
         if ask("Would you like to use pry as your shell? (y/n)") === "y"

data/lib/shopify_api/resources/customer_saved_search.rb

@@ -3,7 +3,7 @@ require 'shopify_api/resources/customer'
 module ShopifyAPI
   class CustomerSavedSearch < Base
     def customers(params = {})
-      Customer.find(:all, :params => params.merge({ :customer_saved_search_id => self.id }))
+      Customer.search(params.merge({:saved_search_id => self.id}))
     end
   end
 end

data/lib/shopify_api/resources/policy.rb

@@ -0,0 +1,7 @@
+module ShopifyAPI
+  class Policy < Base
+    def self.all
+      find(:all)
+    end
+  end
+end

data/lib/shopify_api/resources/recurring_application_charge.rb

@@ -4,11 +4,11 @@ module ShopifyAPI
 
     class << self
       def current
-        all.find { |c| c.status == 'active' }
+        (all || []).find { |c| c.status == 'active' }
       end
 
       [:pending, :cancelled, :accepted, :declined].each do |status|
-        define_method(status) { all.select { |c| c.status == status.to_s } }
+        define_method(status) { (all || []).select { |c| c.status == status.to_s } }
       end
     end
 

data/lib/shopify_api/resources/shop.rb

@@ -3,9 +3,9 @@ module ShopifyAPI
   # the shop.
   class Shop < Base
     def self.current
-      find(:one, :from => "/admin/shop.#{format.extension}")
+      find(:one, from: "/admin/shop.#{format.extension}")
     end
-    
+
     def metafields
       Metafield.find(:all)
     end

data/lib/shopify_api/version.rb

@@ -1,3 +1,3 @@
 module ShopifyAPI
-  VERSION = "3.2.5"
+  VERSION = "3.2.6"
 end

data/shopify_api.gemspec

@@ -14,7 +14,7 @@ Gem::Specification.new do |s|
 
   s.extra_rdoc_files = [
     "LICENSE",
-    "README.rdoc"
+    "README.md"
   ]
   s.files         = `git ls-files`.split("\n")
   s.test_files    = `git ls-files -- {test}/*`.split("\n")

data/test/cli_test.rb

@@ -28,7 +28,7 @@ class CliTest < Test::Unit::TestCase
   test "add with blank domain" do
     standard_add_shop_prompts
     $stdin.expects(:gets).times(4).returns("", "key", "pass", "y")
-    @cli.expects(:puts).with("\nopen https://foo.myshopify.com/admin/api in your browser to get API credentials\n")
+    @cli.expects(:puts).with("\nopen https://foo.myshopify.com/admin/apps/private in your browser to create a private app and get API credentials\n")
     @cli.expects(:puts).with("Default connection is foo")
 
     @cli.add('foo')
@@ -45,7 +45,7 @@ class CliTest < Test::Unit::TestCase
   test "add with explicit domain" do
     standard_add_shop_prompts
     $stdin.expects(:gets).times(4).returns("bar.myshopify.com", "key", "pass", "y")
-    @cli.expects(:puts).with("\nopen https://bar.myshopify.com/admin/api in your browser to get API credentials\n")
+    @cli.expects(:puts).with("\nopen https://bar.myshopify.com/admin/apps/private in your browser to create a private app and get API credentials\n")
     @cli.expects(:puts).with("Default connection is foo")
 
     @cli.add('foo')
@@ -57,7 +57,7 @@ class CliTest < Test::Unit::TestCase
   test "add with irb as shell" do
     standard_add_shop_prompts
     $stdin.expects(:gets).times(4).returns("bar.myshopify.com", "key", "pass", "fuuuuuuu")
-    @cli.expects(:puts).with("\nopen https://bar.myshopify.com/admin/api in your browser to get API credentials\n")
+    @cli.expects(:puts).with("\nopen https://bar.myshopify.com/admin/apps/private in your browser to create a private app and get API credentials\n")
     @cli.expects(:puts).with("Default connection is foo")
 
     @cli.add('foo')

data/test/customer_saved_search_test.rb

@@ -7,13 +7,13 @@ class CustomerSavedSearchTest < Test::Unit::TestCase
   end
 
   def test_get_customers_from_customer_saved_search
-    fake 'customers.json?customer_saved_search_id=8899730', :body => load_fixture('customer_saved_search_customers'), :extension => false
+    fake 'customers/search.json?saved_search_id=8899730', :body => load_fixture('customer_saved_search_customers'), :extension => false
     assert_equal 1, @customer_saved_search.customers.length
     assert_equal 112223902, @customer_saved_search.customers.first.id
   end
 
   def test_get_customers_from_customer_saved_search_with_params
-    fake 'customers.json?customer_saved_search_id=8899730&limit=1', :body => load_fixture('customer_saved_search_customers'), :extension => false
+    fake 'customers/search.json?saved_search_id=8899730&limit=1', :body => load_fixture('customer_saved_search_customers'), :extension => false
     customers = @customer_saved_search.customers(:limit => 1)
     assert_equal 1, customers.length
     assert_equal 112223902, customers.first.id

data/test/fixtures/policies.json

@@ -0,0 +1,8 @@
+{
+  "policies": [
+    {
+      "title": "Privacy Policy",
+      "body": "Your privacy is important to us"
+    }
+  ]
+}

data/test/policy_test.rb

@@ -0,0 +1,19 @@
+require 'test_helper'
+
+class PolicyTest < Test::Unit::TestCase
+  def setup
+    super
+    fake 'shop'
+  end
+
+  def test_getting_the_list_of_policies
+    fake 'policies'
+
+    policies = ShopifyAPI::Policy.all
+    assert_equal 1, policies.length
+
+    policy = policies.first
+    assert_equal 'Privacy Policy', policy.title
+    assert_equal 'Your privacy is important to us', policy.body
+  end
+end

data/test/recurring_application_charge_test.rb

@@ -104,4 +104,12 @@ class RecurringApplicationChargeTest < Test::Unit::TestCase
     assert_equal [], ShopifyAPI::RecurringApplicationCharge.pending
   end
 
+  def test_recurring_application_charge_not_found_error
+    fake "recurring_application_charges", :body => '{"errors":"Not Found"}', :status => 404
+
+    assert_equal nil, ShopifyAPI::RecurringApplicationCharge.all
+    assert_equal nil, ShopifyAPI::RecurringApplicationCharge.current
+    assert_equal [],  ShopifyAPI::RecurringApplicationCharge.pending
+  end
+
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: shopify_api
 version: !ruby/object:Gem::Version
-  version: 3.2.5
+  version: 3.2.6
 platform: ruby
 authors:
 - Shopify
@@ -30,7 +30,7 @@ cert_chain:
   fl3hbtVFTqbOlwL9vy1fudXcolIE/ZTcxQ+er07ZFZdKCXayR9PPs64heamfn0fp
   TConQSX2BnZdhIEYW+cKzEC/bLc=
   -----END CERTIFICATE-----
-date: 2014-08-06 00:00:00.000000000 Z
+date: 2014-12-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activeresource
@@ -140,7 +140,7 @@ executables:
 extensions: []
 extra_rdoc_files:
 - LICENSE
-- README.rdoc
+- README.md
 files:
 - ".document"
 - ".gitignore"
@@ -154,7 +154,7 @@ files:
 - Gemfile_ar32
 - Gemfile_ar40threadsafe
 - LICENSE
-- README.rdoc
+- README.md
 - RELEASING
 - Rakefile
 - bin/shopify
@@ -203,6 +203,7 @@ files:
 - lib/shopify_api/resources/order_risk.rb
 - lib/shopify_api/resources/page.rb
 - lib/shopify_api/resources/payment_details.rb
+- lib/shopify_api/resources/policy.rb
 - lib/shopify_api/resources/product.rb
 - lib/shopify_api/resources/province.rb
 - lib/shopify_api/resources/receipt.rb
@@ -259,6 +260,7 @@ files:
 - test/fixtures/order_risk.json
 - test/fixtures/order_risks.json
 - test/fixtures/orders.json
+- test/fixtures/policies.json
 - test/fixtures/product.json
 - test/fixtures/recurring_application_charge.json
 - test/fixtures/recurring_application_charges.json
@@ -278,6 +280,7 @@ files:
 - test/metafield_test.rb
 - test/order_risk_test.rb
 - test/order_test.rb
+- test/policy_test.rb
 - test/product_test.rb
 - test/recurring_application_charge_test.rb
 - test/script_tag_test.rb

metadata.gz.sig

@@ -1,2 +1,2 @@
-e��h1Y�.\����^CZ�Ŏ�jrN��Z(��W)H�Efq�����%��{2A�4C������y�W���g�M�2�N�:�]cA@�B<�3��U٥57�XC�K���
-�� !:m0��E/0�[�b	�y�(\��}�I�P���´8�r��9�Sf��Y����������Z�٫�/=��~3�'�U��GN#�f!�Vً�O+r-�m�e�ϣe��w��M��դ<����ʹ%W����
+x�$㭔�ώI
+��>�C!e���GB��N:�SNt�2�6�m>@��1rke�)��tR��Ȑ�ڍ���hb��CnM��~܇~e@��"���hˢI�z�:SHH��MM����������=�ƪ�����RDŽ�܋� �5��OSA�pq�{$!�*�J�����/+��G���#�tj��R��Q�_���HT�uכd�q�;��}��):�;����

data/README.rdoc

@@ -1,170 +0,0 @@
-{<img src="https://travis-ci.org/Shopify/shopify_api.png?branch=master" alt="Build Status" />}[https://travis-ci.org/Shopify/shopify_api]
-= Shopify API
-
-The Shopify API gem allows Ruby developers to programmatically access the admin section of Shopify stores.
-
-The API is implemented as JSON over HTTP using all four verbs (GET/POST/PUT/DELETE). Each resource, like Order, Product, or Collection, has its own URL and is manipulated in isolation. In other words, we’ve tried to make the API follow the REST principles as much as possible.
-
-
-== Usage
-
-=== Requirements
-
-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
-* 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
-
-
-=== Installation
-
-To easily install or upgrade to the latest release, use {gem}[http://rubygems.org/]
-
-    gem install shopify_api
-
-
-=== 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:
-
-1. First create a new application in either the partners admin or your store admin. For a private App you'll need the API_KEY and the PASSWORD otherwise you'll need the API_KEY and SHARED_SECRET.
-
-2. For a private App you just need to set the base site url as follows:
-
-    shop_url = "https://#{API_KEY}:#{PASSWORD}@SHOP_NAME.myshopify.com/admin"
-    ShopifyAPI::Base.site = shop_url
-
-   That's it, you're done, skip to step 7 and start using the API!
-
-   For a partner app you will need to supply two parameters to the Session class before you instantiate it:
-
-    ShopifyAPI::Session.setup({:api_key => API_KEY, :secret => SHARED_SECRET})
-
-3. In order to access a shop's data, apps need an access token from that specific shop. This is a two-stage process. Before interacting with a shop for the first time an app should redirect the user to the following URL:
-
-    GET https://SHOP_NAME.myshopify.com/admin/oauth/authorize
-
-   with the following parameters:
-
-   * 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.
-
-   We've added the create_permision_url method to make this easier, first instantiate your session object:
-
-    session = ShopifyAPI::Session.new("SHOP_NAME.myshopify.com")
-
-   Then call:
-
-    scope = ["write_products"]
-    permission_url = session.create_permission_url(scope)
-
-   or if you want a custom redirect_uri:
-
-    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:
-
-    POST https://SHOP_NAME.myshopify.com/admin/oauth/access_token
-
-   with the following parameters:
-
-   * client_id – Required – The API key for your app
-   * client_secret – Required – The shared secret for your app
-   * code – Required – The token you received in step 3
-
-   and you'll get your permanent access token back in the response.
-
-   There is a method to make the request and get the token for you. Pass
-   all the params received from the previous call and the method will verify
-   the params, extract the temp code and then request your token:
-
-    token = session.request_token(params)
-
-   This method will save the token to the session object and return it. For future sessions simply pass the token in when creating the session object:
-
-    session = ShopifyAPI::Session.new("SHOP_NAME.myshopify.com", token)
-
-5. The session must be activated before use:
-
-    ShopifyAPI::Base.activate_session(session)
-
-6. Now you're ready to make authorized API requests to your shop! Data is returned as ActiveResource instances:
-
-    shop = ShopifyAPI::Shop.current
-
-    # Get a specific product
-    product = ShopifyAPI::Product.find(179761209)
-
-    # Create a new product
-    new_product = ShopifyAPI::Product.new
-    new_product.title = "Burton Custom Freestlye 151"
-    new_product.product_type = "Snowboard"
-    new_product.vendor = "Burton"
-    new_product.save
-
-    # Update a product
-    product.handle = "burton-snowboard"
-    product.save
-
-   Alternatively, you can use #temp to initialize a Session and execute a command which also handles temporarily setting ActiveResource::Base.site:
-
-    products = ShopifyAPI::Session.temp("SHOP_NAME.myshopify.com", token) { ShopifyAPI::Product.find(:all) }
-
-8. If you want to work with another shop, you'll first need to clear the session:
-
-    ShopifyAPI::Base.clear_session
-
-
-=== 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.
-
-1. 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.
-
-    shopify add yourshopname
-
-   Follow the prompts for the shop domain, API key and password.
-
-3. Start the console for the connection.
-
-    shopify console
-
-4. To see the full list of commands, type:
-
-    shopify help
-
-
-== Threadsafety
-
-ActiveResource is inherently non-threadsafe, because class variables like ActiveResource::Base.site
-and ActiveResource::Base.headers are shared between threads. This can cause conflicts when using
-threaded libraries, like Sidekiq.
-
-We have a forked version of ActiveResource that stores these class variables in threadlocal
-variables. Using this forked version will allow ShopifyAPI to be used in a threaded environment.
-
-To enable threadsafety with ShopifyAPI, add the following to your Gemfile:
-
-    gem 'activeresource', git: 'git://github.com/Shopify/activeresource', branch: 'threadsafe'
-    gem 'shopify_api', '>= 3.2.1'
-
-== Using Development Version
-
-Download the source code and run:
-
-    rake install
-
-== Additional Resources
-
-http://docs.shopify.com/api <= Read the tech docs!
-
-http://ecommerce.shopify.com/c/shopify-apis-and-technology <= Ask questions on the forums!
-
-== Copyright
-
-Copyright (c) 2012 "Shopify inc.". See LICENSE for details.