shopify_api 3.1.8 → 3.2.0

data/.gitignore

@@ -4,3 +4,4 @@ coverage
 rdoc
 doc
 pkg
+.ruby-version

data/.travis.yml

@@ -0,0 +1,32 @@
+language: ruby
+
+rvm:
+  - 2.0.0
+  - 1.9.3
+
+gemfile:
+  - Gemfile
+  - Gemfile_ar30
+  - Gemfile_ar31
+  - Gemfile_ar32
+
+install: bundle install
+
+before_script: echo $OLD_RAKE
+
+matrix:
+  include:
+    - rvm: 1.9.2
+      gemfile: Gemfile_ar30
+      env: OLD_RAKE=1
+    - rvm: 1.9.2
+      gemfile: Gemfile_ar31
+      env: OLD_RAKE=1
+    - rvm: 1.9.2
+      gemfile: Gemfile_ar32
+      env: OLD_RAKE=1
+
+
+notifications:
+  flowdock: 
+    secure: "RCgSxzMScnqK6bOwkv9sWSdieLBeJla8NcDtM/QmuFW8soTgV6qCTAPAGd4lpjg4vGTaM3DsdHU5GMDbgdWN5dE2Rf09ayFqiZg8OloPMQ63KIwLJyVcw3cVJO5i7smjIpsSjPjBkvAXHIOFcKdsnuYGS4YD8hjl+QrZ3ghi440="

data/CHANGELOG

@@ -1,6 +1,18 @@
+== Version 3.2.0
+
+* in Session::request_token params is no longer optional, you must pass all the params and the method will now extract the code
+* Fixed JSON errors handling (#103)
+* Fixed compatibility with Ruby 2.1.x (#83)
+* Fixed getting parent ID from nested resources like Variants (#44)
+* Cleaned up compatibility with ActiveResource 4.0.x
+* Added OrderRisk resource
+* Added FulfillmentService resource
+* Removed discontinued ProductSearchEngine resource
+* Added convenience method Customer#search (#45)
+
 == Version 3.1.8
 
-* Expose `index` and `show` actions of `Location` 
+* Expose `index` and `show` actions of `Location`
 * Added create_permission_url and request_token helper methods
 * Edited the readme to better describe the getting started procedure
 
@@ -114,7 +126,7 @@ requests/responses
 
 == Version 1.1.1 (October 5, 2010)
 
-* Remove hard coded xml formatting in API calls 
+* Remove hard coded xml formatting in API calls
 * Remove jeweler stuff
 * Ruby 1.9 encoding fix
 

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    shopify_api (3.1.8)
+    shopify_api (3.2.0)
       activeresource (>= 3.0.0)
       thor (>= 0.14.4)
 
@@ -24,7 +24,7 @@ GEM
     atomic (1.1.14)
     builder (3.1.4)
     fakeweb (1.3.0)
-    i18n (0.6.5)
+    i18n (0.6.9)
     metaclass (0.0.1)
     minitest (4.7.5)
     mocha (0.14.0)

data/Gemfile_ar30

@@ -0,0 +1,9 @@
+source "https://rubygems.org"
+
+gemspec
+
+gem "activeresource", "~> 3.0.0"
+
+if ENV['OLD_RAKE'] == '1'
+  gem "rake", "~> 0.9.2"
+end

data/Gemfile_ar31

@@ -0,0 +1,9 @@
+source "https://rubygems.org"
+
+gemspec
+
+gem "activeresource", "~> 3.1.0"
+
+if ENV['OLD_RAKE'] == '1'
+  gem "rake", "~> 0.9.2"
+end

data/Gemfile_ar32

@@ -0,0 +1,9 @@
+source "https://rubygems.org"
+
+gemspec
+
+gem "activeresource", "~> 3.2.0"
+
+if ENV['OLD_RAKE'] == '1'
+  gem "rake", "~> 0.9.2"
+end

data/README.rdoc

@@ -1,3 +1,4 @@
+{<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.
@@ -12,7 +13,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
-* Shopify Partners create applications through their admin: http://app.shopify.com/services/partners 
+* 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
 
@@ -31,11 +32,11 @@ ShopifyAPI uses ActiveResource to communicate with the REST web service. ActiveR
 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!
+   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:
 
@@ -52,15 +53,15 @@ ShopifyAPI uses ActiveResource to communicate with the REST web service. ActiveR
    * 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:
+   Then call:
 
     scope = ["write_products"]
     permission_url = session.create_permission_url(scope)
 
-  or if you want a custom redirect_uri:  
+   or if you want a custom redirect_uri:
 
     permission_url = session.create_permission_url(scope, "https://my_redirect_uri.com")
 
@@ -69,18 +70,20 @@ ShopifyAPI uses ActiveResource to communicate with the REST web service. ActiveR
     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:
+   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(code)
+    token = session.request_token(params)
 
-   Which will request the token, save it to the session object and return it. For future sessions simply pass the token in when creating the session object:
+   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)
 
@@ -110,18 +113,18 @@ ShopifyAPI uses ActiveResource to communicate with the REST web service. ActiveR
 
     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::
+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.
+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.
+2. Use the +shopify+ script to save the credentials for the shop to quickly log in.
 
     shopify add yourshopname
 
@@ -139,12 +142,12 @@ This package also includes the `shopify` executable to make it easy to open up a
 == Using Development Version
 
 Download the source code and run:
-    
+
     rake install
 
 == Additional Resources
 
-http://api.shopify.com <= Read the tech docs!
+http://docs.shopify.com/api <= Read the tech docs!
 
 http://ecommerce.shopify.com/c/shopify-apis-and-technology <= Ask questions on the forums!
 

data/lib/active_resource/base_ext.rb

@@ -1,22 +1,21 @@
 module ActiveResource
   class Base
-    # Backported from ActiveResource master branch
-    def self.headers
-      @headers ||= {}
+    if ActiveResource::VERSION::MAJOR < 4
+      # Backported from ActiveResource master branch
+      def self.headers
+        @headers ||= {}
 
-      if superclass != Object && superclass.headers
-        @headers = superclass.headers.merge(@headers)
-      else
-        @headers
+        if superclass != Object && superclass.headers
+          @headers = superclass.headers.merge(@headers)
+        else
+          @headers
+        end
+      end
+
+      # https://github.com/rails/activeresource/commit/dfef85ce8f653f75673631b2950fcdb0781c313c
+      def self.delete(id, options = {})
+        connection.delete(element_path(id, options), headers)
       end
-    end
-    # https://github.com/rails/activeresource/commit/dfef85ce8f653f75673631b2950fcdb0781c313c
-    def self.delete(id, options = {})
-      connection.delete(element_path(id, options), headers)
-    end
-    def self.build(attributes = {})
-      attrs = self.format.decode(connection.get("#{new_element_path}", headers).body).merge(attributes)
-      self.new(attrs)
     end
   end
 end

data/lib/active_resource/disable_prefix_check.rb

@@ -17,6 +17,20 @@ module DisablePrefixCheck
 
         options[resource_id].nil? ? "/admin/" : "/admin/#{resource_type}/#{options[resource_id]}/"
       end
+
+      define_singleton_method :instantiate_record do |record, prefix_options = {}|
+        new_record(record).tap do |resource|
+          resource.prefix_options = prefix_options unless prefix_options.blank?
+        end
+      end
+    end
+
+    def new_record(record)
+      if ActiveSupport::VERSION::MAJOR == 3 && ActiveSupport::VERSION::MINOR == 0
+        new(record)
+      else
+        new(record, true)
+      end
     end
   end
 end

data/lib/active_resource/json_errors.rb

@@ -2,6 +2,16 @@ require 'active_resource/base'
 
 module ActiveResource
   class Errors < ActiveModel::Errors
+    def from_json(json, save_cache = false)
+      data = ActiveSupport::JSON.decode(json)['errors'] || {} rescue {}
+      case data
+      when String
+        from_string(data, save_cache)
+      else
+        from_hash(data, save_cache)
+      end
+    end
+
     def from_hash(messages, save_cache = false)
       clear unless save_cache
 
@@ -12,10 +22,10 @@ module ActiveResource
       end
     end
 
-    # Grabs errors from a json response.
-    def from_json(json, save_cache = false)
-      hash = ActiveSupport::JSON.decode(json)['errors'] || {} rescue {}
-      from_hash hash, save_cache
+    def from_string(error, save_cache = false)
+      clear unless save_cache
+
+      add("message", error)
     end
   end
 end

data/lib/active_resource/to_query.rb

@@ -0,0 +1,10 @@
+# ActiveSupport 3.0 doesn't URL-encode paths with arrays as params properly.
+# Backported from ActiveSupport > 3.0
+if ActiveSupport::VERSION::MAJOR == 3 && ActiveSupport::VERSION::MINOR == 0
+  class Object
+    def to_query(key)
+      require 'cgi' unless defined?(CGI) && defined?(CGI::escape)
+      "#{CGI.escape(key.to_param)}=#{CGI.escape(to_param.to_s)}"
+    end
+  end
+end

data/lib/shopify_api.rb

@@ -11,6 +11,7 @@ require 'shopify_api/json_format'
 require 'active_resource/json_errors'
 require 'active_resource/disable_prefix_check'
 require 'active_resource/base_ext'
+require 'active_resource/to_query'
 
 module ShopifyAPI
   include Limits

data/lib/shopify_api/resources.rb

@@ -1,2 +1,2 @@
 require 'shopify_api/resources/base'
-Dir.glob "#{File.dirname(__FILE__)}/resources/*", &method(:require)
+Dir.glob("#{File.dirname(__FILE__)}/resources/*").each { |file| require(file) } 

data/lib/shopify_api/resources/base.rb

@@ -52,6 +52,10 @@ module ShopifyAPI
 
       def init_prefix_explicit(resource_type, resource_id)
         self.prefix = "/admin/#{resource_type}/:#{resource_id}/"
+
+        define_method resource_id.to_sym do
+          @prefix_options[resource_id]
+        end
       end
     end
 

data/lib/shopify_api/resources/customer.rb

@@ -3,8 +3,11 @@ module ShopifyAPI
     include Metafields
 
     def orders
-      Order.find(:all, :params => {:customer_id => self.id})
+      Order.find(:all, params: {customer_id: self.id})
     end
 
+    def self.search(params)
+      find(:all, from: :search, params: params)
+    end
   end
 end

data/lib/shopify_api/resources/fulfillment_service.rb

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

data/lib/shopify_api/resources/order_risk.rb

@@ -0,0 +1,8 @@
+module ShopifyAPI
+  class OrderRisk < Base
+    init_prefix :order
+
+    self.collection_name = "risks"
+    self.element_name = "risk"
+  end
+end

data/lib/shopify_api/session.rb

@@ -1,20 +1,20 @@
 
 module ShopifyAPI
-  
+
   class Session
     cattr_accessor :api_key
     cattr_accessor :secret
-    cattr_accessor :protocol 
+    cattr_accessor :protocol
     self.protocol = 'https'
 
     attr_accessor :url, :token, :name
-    
+
     class << self
-    
+
       def setup(params)
         params.each { |k,value| send("#{k}=", value) }
       end
-      
+
       def temp(domain, token, &block)
         session = new(domain, token)
         begin
@@ -31,7 +31,7 @@ module ShopifyAPI
           ShopifyAPI::Base.activate_session(original_session)
         end
       end
-      
+
       def prepare_url(url)
         return nil if url.blank?
         url.gsub!(/https?:\/\//, '')                            # remove http:// or https://
@@ -57,16 +57,10 @@ module ShopifyAPI
       end
 
     end
-    
-    def initialize(url, token = nil, params = nil)
+
+    def initialize(url, token = nil)
       self.url, self.token = url, token
       self.class.prepare_url(self.url)
-
-      if params
-        unless self.class.validate_signature(params) && params[:timestamp].to_i > 24.hours.ago.utc.to_i
-          raise "Invalid Signature: Possible malicious login" 
-        end
-      end
     end
 
     def create_permission_url(scope, redirect_uri = nil)
@@ -75,9 +69,15 @@ module ShopifyAPI
       "#{protocol}://#{url}/admin/oauth/authorize?#{parameterize(params)}"
     end
 
-    def request_token(code)
+    def request_token(params)
       return token if token
-      
+
+      unless self.class.validate_signature(params) && params[:timestamp].to_i > 24.hours.ago.utc.to_i
+        raise "Invalid Signature: Possible malicious login"
+      end
+
+      code = params['code']
+
       response = access_token_request(code)
 
       if response.code == "200"
@@ -98,14 +98,14 @@ module ShopifyAPI
     def valid?
       url.present? && token.present?
     end
-  
+
     private
       def parameterize(params)
         URI.escape(params.collect{|k,v| "#{k}=#{v}"}.join('&'))
       end
 
       def access_token_request(code)
-        uri = URI.parse("#{protocol}://#{url}/admin/oauth/access_token")      
+        uri = URI.parse("#{protocol}://#{url}/admin/oauth/access_token")
         https = Net::HTTP.new(uri.host, uri.port)
         https.use_ssl = true
         request = Net::HTTP::Post.new(uri.request_uri)