th_shopify_api 1.2.6.pre

data/.document

@@ -0,0 +1,5 @@
+README.rdoc
+lib/**/*.rb
+bin/*
+features/**/*.feature
+LICENSE

data/.gitignore

@@ -0,0 +1,5 @@
+*.sw?
+.DS_Store
+coverage
+rdoc
+pkg

data/CHANGELOG

@@ -0,0 +1,57 @@
+== Version 1.2.5
+
+* Fix for Article#comments
+
+== Version 1.2.4
+
+* Added Article#comments
+* Added Order#cancel
+* Added Comment#restore, #not_spam
+
+== Version 1.2.3
+
+* Added Customer, CustomerGroup support
+
+== Version 1.2.2
+
+* Added ScriptTag support
+
+== Version 1.2.1
+
+* Allow abbreviated names for all commands like rails does, e.g. 'shopify c' instead of 'shopify console'
+* Fix Variant to support accessing both nested variants with a product prefix as well as top level variants directly
+* Add 'grande' to supported product image size variants
+
+== Version 1.2.0
+
+* Command-line interface
+* Allow custom params when fetching a single Asset
+
+== Version 1.1.3 (November 4, 2010)
+
+* Add ProductSearchEngines resource
+
+== Version 1.1.2 (October 20, 2010)
+
+* Fix for users of ActiveResource 3.x
+
+== Version 1.1.1 (October 5, 2010)
+
+* Remove hard coded xml formatting in API calls 
+* Remove jeweler stuff
+* Ruby 1.9 encoding fix
+
+== Version 1.1.0 (September 24, 2010)
+
+* Add new Events API for Shop, Order, Product, CustomCollection, SmartCollection, Page, Blog and Article
+* Add new 'compact' product image size variant
+* Rails 3 fix: attribute_accessors has to be explicitly included since activesupport 3.0.0
+
+== Version 1.0.6
+
+* Add metafields
+* Add latest changes from Shopify including asset support, token validation and a common base class
+
+== Version 1.0.0
+
+* extracting ShopifyAPI from Shopify into Gem

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 "JadedPixel inc."
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.rdoc

@@ -0,0 +1,60 @@
+= Shopify API
+
+The Shopify API gem allows Ruby developers to programmatically access the admin section of Shopify stores.
+
+The API is implemented as XML 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 (under the Preferences > Applications tab).
+* 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
+
+=== 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 and write down your API_KEY and SHARED_SECRET.
+
+2. 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. Create a new Session for a specific shop. That session is not fully valid yet, but it can be used to create a URL that you will redirect your users to:
+
+    session = ShopifyAPI::Session.new("yourshopname.myshopify.com")
+    session.valid?  # returns false
+
+4. To access the API shop owners need a "token" from that specific shop. In order to get this token they need to authorize with that shop first. The URL to redirect your user to can be generated via:
+
+    url = session.create_permission_url
+
+5. After visiting this URL, the shop redirects the owner to a custom URL of your application where the "token" gets sent to (it's param name is just "t"). Use that token to instantiate a "valid" session, that is ready to make calls to that particular shop.
+
+    token = params[:t]
+    session = ShopifyAPI::Session.new("yourshopname.myshopify.com", token)
+    session.valid?  # returns true
+
+6. Now you can finally get the fully authorized URL for that shop. Use that URL to configure ActiveResource and you're set:
+
+     ActiveResource::Base.site = session.site
+
+7. Get data from that shop (returns ActiveResource instances):
+
+     shop = ShopifyAPI::Shop.current
+     latest_orders = ShopifyAPI::Order.find(:all)
+
+   Alternatively, you can use #temp to initialize a Session and execute a command which also handles temporarily setting ActiveResource::Base.site:
+
+    latest_orders = ShopifyAPI::Session.temp("yourshopname.myshopify.com", token) { ShopifyAPI::Order.find(:all) }
+
+
+== Copyright
+
+Copyright (c) 2011 "JadedPixel inc.". See LICENSE for details.

data/RELEASING

@@ -0,0 +1,16 @@
+Releasing ShopifyAPI
+
+1. Check the Semantic Versioning page for info on how to version the new release: http://semver.org
+2. Update the version of ShopifyAPI in shopify_api.gemspec
+3. Add a CHANGELOG entry for the new release with the date (also include the updated date in shopify_api.gemspec)
+4. Commit the changes with a commit message like "Packaging for release X.Y.Z"
+5. Tag the release with the version (Leave REV blank for HEAD or provide a SHA)
+  $ git tag vX.Y.Z REV
+6. Push out the changes
+  $ git push
+7. Push out the tags
+  $ git push --tags
+8. Build the new .gem from the updated .gemspec
+  $ gem build shopify_api.gemspec
+9. Publish the Gem to gemcutter
+  $ gem push shopify_api-X.Y.Z.gem

data/Rakefile

@@ -0,0 +1,41 @@
+# encoding: UTF-8
+require 'rubygems'
+require 'rake'
+
+require 'rake/testtask'
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib' << 'test'
+  test.pattern = 'test/**/*_test.rb'
+  test.verbose = true
+end
+
+begin
+  require 'rcov/rcovtask'
+  Rcov::RcovTask.new do |test|
+    test.libs << 'test'
+    test.pattern = 'test/**/*_test.rb'
+    test.verbose = true
+  end
+rescue LoadError
+  task :rcov do
+    abort "RCov is not available. In order to run rcov, you must: sudo gem install spicycode-rcov"
+  end
+end
+
+
+task :default => :test
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  if File.exist?('VERSION.yml')
+    config = YAML.load(File.read('VERSION.yml'))
+    version = "#{config[:major]}.#{config[:minor]}.#{config[:patch]}"
+  else
+    version = ""
+  end
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "shopify_api #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/bin/shopify

@@ -0,0 +1,4 @@
+#!/usr/bin/env ruby
+require File.expand_path('../../lib/shopify_api',__FILE__)
+require File.expand_path('../../lib/shopify_api/cli',__FILE__)
+ShopifyAPI::Cli.start(ARGV)

data/lib/active_resource/connection_ext.rb

@@ -0,0 +1,16 @@
+require 'active_support/core_ext/module/aliasing'
+
+module ActiveResource
+  class Connection
+    
+    attr_reader :response
+    
+    def handle_response_with_response_capture(response)
+      @response = handle_response_without_response_capture(response)
+    end
+    
+    alias_method_chain :handle_response, :response_capture
+    # alias_method :handle_response_without_instance, :handle_response
+    # alias_method :handle_response, :handle_response_with_instance
+  end
+end

data/lib/shopify_api.rb

@@ -0,0 +1,18 @@
+$:.unshift File.dirname(__FILE__)
+
+require 'active_resource'
+require 'active_support/core_ext/class/attribute_accessors'
+require 'digest/md5'
+require 'base64'
+require 'active_resource/connection_ext'
+require 'shopify_api/limits'
+
+module ShopifyAPI
+  include Limits
+end
+
+require 'shopify_api/events'
+require 'shopify_api/metafields'
+require 'shopify_api/countable'
+require 'shopify_api/resources'
+require 'shopify_api/session'

data/lib/shopify_api/countable.rb

@@ -0,0 +1,7 @@
+module ShopifyAPI
+  module Countable
+    def count(options = {})
+      Integer(get(:count, options))
+    end
+  end
+end

data/lib/shopify_api/events.rb

@@ -0,0 +1,7 @@
+module ShopifyAPI
+  module Events
+    def events
+      Event.find(:all, :params => {:resource => self.class.collection_name, :resource_id => id})
+    end
+  end
+end

data/lib/shopify_api/limits.rb

@@ -0,0 +1,76 @@
+module ShopifyAPI
+  module Limits
+    def self.included(klass)
+      klass.send(:extend, ClassMethods)
+    end
+    
+    module ClassMethods
+
+      # Takes form num_requests_executed/max_requests
+      # Eg: 101/3000
+      CREDIT_LIMIT_HEADER_PARAM = {
+        :global => 'http_x_shopify_api_call_limit',
+        :shop => 'http_x_shopify_shop_api_call_limit'
+      }
+
+        ##
+      # How many more API calls can I make?
+      # @return {Integer}
+      #
+      def credit_left
+        shop = credit_limit(:shop) - credit_used(:shop)
+        global = credit_limit(:global) - credit_used(:global)      
+        shop < global ? shop : global
+      end
+      alias_method :available_calls, :credit_left
+      
+      ##
+      # Have I reached my API call limit?
+      # @return {Boolean}
+      #
+      def credit_maxed?
+        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/2999 or shop/global limits.
+      # @param {Symbol} scope [:shop|:global]
+      # @return {Integer}
+      #
+      def credit_limit(scope=:shop)
+        @api_credit_limit ||= {}
+        @api_credit_limit[scope] ||= api_credit_limit_param(scope).pop.to_i - 1     
+      end
+      alias_method :call_limit, :credit_limit
+
+      ##
+      # How many API calls have I made?
+      # @param {Symbol} scope [:shop|:global]
+      # @return {Integer}
+      #
+      def credit_used(scope=:shop)
+        api_credit_limit_param(scope).shift.to_i
+      end
+      alias_method :call_count, :credit_used
+      
+      ##
+      # @return {HTTPResonse}
+      #
+      def response
+        Shop.current unless ShopifyAPI::Base.connection.response
+        ShopifyAPI::Base.connection.response
+      end
+
+      private
+
+      ##
+      # @return {Array}
+      #
+      def api_credit_limit_param(scope)    
+        response[CREDIT_LIMIT_HEADER_PARAM[scope]].split('/')
+      end    
+    end
+  end
+end

data/lib/shopify_api/metafields.rb

@@ -0,0 +1,18 @@
+module ShopifyAPI
+  module Metafields
+    def metafields
+      Metafield.find(:all, :params => {:resource => self.class.collection_name, :resource_id => id})
+    end
+
+    def add_metafield(metafield)
+      raise ArgumentError, "You can only add metafields to resource that has been saved" if new?
+
+      metafield.prefix_options = {
+        :resource => self.class.collection_name,
+        :resource_id => id
+      }
+      metafield.save
+      metafield
+    end
+  end
+end

data/lib/shopify_api/resources.rb

@@ -0,0 +1,40 @@
+require 'shopify_api/resources/base'
+require 'shopify_api/resources/address'
+require 'shopify_api/resources/application_charge'
+require 'shopify_api/resources/article'
+require 'shopify_api/resources/asset'
+require 'shopify_api/resources/billing_address'
+require 'shopify_api/resources/blog'
+require 'shopify_api/resources/collect'
+require 'shopify_api/resources/comment'
+require 'shopify_api/resources/country'
+require 'shopify_api/resources/custom_collection'
+require 'shopify_api/resources/customer_group'
+require 'shopify_api/resources/customer'
+require 'shopify_api/resources/event'
+require 'shopify_api/resources/fulfillment'
+require 'shopify_api/resources/image'
+require 'shopify_api/resources/line_item'
+require 'shopify_api/resources/metafield'
+require 'shopify_api/resources/note_attribute'
+require 'shopify_api/resources/option'
+require 'shopify_api/resources/order'
+require 'shopify_api/resources/page'
+require 'shopify_api/resources/payment_details'
+require 'shopify_api/resources/product'
+require 'shopify_api/resources/product_search_engine'
+require 'shopify_api/resources/province'
+require 'shopify_api/resources/receipt'
+require 'shopify_api/resources/recurring_application_charge'
+require 'shopify_api/resources/redirect'
+require 'shopify_api/resources/rule'
+require 'shopify_api/resources/script_tag'
+require 'shopify_api/resources/shipping_address'
+require 'shopify_api/resources/shipping_line'
+require 'shopify_api/resources/shop'
+require 'shopify_api/resources/smart_collection'
+require 'shopify_api/resources/tax_line'
+require 'shopify_api/resources/theme'
+require 'shopify_api/resources/transaction'
+require 'shopify_api/resources/variant'
+require 'shopify_api/resources/webhook'

data/lib/shopify_api/resources/address.rb

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

data/lib/shopify_api/resources/application_charge.rb

@@ -0,0 +1,9 @@
+module ShopifyAPI
+  class ApplicationCharge < Base
+    undef_method :test
+
+    def activate
+      load_attributes_from_response(post(:activate))
+    end
+  end
+end

data/lib/shopify_api/resources/article.rb

@@ -0,0 +1,12 @@
+module ShopifyAPI
+  class Article < Base
+    include Events
+    include Metafields
+
+    self.prefix = "/admin/blogs/:blog_id/"
+    
+    def comments
+      Comment.find(:all, :params => { :article_id => id })
+    end
+  end
+end

data/lib/shopify_api/resources/asset.rb

@@ -0,0 +1,95 @@
+module ShopifyAPI
+  # Assets represent the files that comprise your theme.
+  # There are different buckets which hold different kinds
+  # of assets, each corresponding to one of the folders
+  # within a theme's zip file: "layout", "templates",
+  # "snippets", "assets", and "config". The full key of an
+  # asset always starts with the bucket name, and the path
+  # separator is a forward slash, like layout/theme.liquid
+  # or assets/bg-body.gif.
+  #
+  # Initialize with a key:
+  #   asset = ShopifyAPI::Asset.new(:key => 'assets/special.css', :theme_id => 12345)
+  # 
+  # Find by key:
+  #   asset = ShopifyAPI::Asset.find('assets/image.png', :params => {:theme_id => 12345})
+  # 
+  # Get the text or binary value:
+  #   asset.value # decodes from attachment attribute if necessary
+  # 
+  # You can provide new data for assets in a few different ways:
+  # 
+  #   * assign text data for the value directly:
+  #       asset.value = "div.special {color:red;}"
+  #     
+  #   * provide binary data for the value:
+  #       asset.attach(File.read('image.png'))
+  #     
+  #   * set a URL from which Shopify will fetch the value:
+  #       asset.src = "http://mysite.com/image.png"
+  #     
+  #   * set a source key of another of your assets from which
+  #     the value will be copied:
+  #       asset.source_key = "assets/another_image.png"
+  class Asset < Base
+    self.primary_key = 'key'
+    self.prefix = "/admin/themes/:theme_id/"
+    
+    def self.prefix(options={})
+      options[:theme_id].nil? ? "/admin/" : "/admin/themes/#{options[:theme_id]}/"
+    end
+    
+    def self.element_path(id, prefix_options = {}, query_options = nil) #:nodoc:
+      prefix_options, query_options = split_options(prefix_options) if query_options.nil?
+      "#{prefix(prefix_options)}#{collection_name}.#{format.extension}#{query_string(query_options)}"
+    end
+    
+    # find an asset by key:
+    #   ShopifyAPI::Asset.find('layout/theme.liquid', :params => {:theme_id => 99})
+    def self.find(*args)
+      if args[0].is_a?(Symbol)
+        super
+      else
+        params = {:asset => {:key => args[0]}}
+        params = params.merge(args[1][:params]) if args[1] && args[1][:params]
+        path_prefix = params[:theme_id] ? "/admin/themes/#{params[:theme_id]}" : "/admin"
+        find(:one, :from => "#{path_prefix}/assets.#{format.extension}", :params => params)
+      end
+    end
+    
+    # For text assets, Shopify returns the data in the 'value' attribute.
+    # For binary assets, the data is base-64-encoded and returned in the
+    # 'attachment' attribute. This accessor returns the data in both cases.
+    def value
+      attributes['value'] ||
+      (attributes['attachment'] ? Base64.decode64(attributes['attachment']) : nil)
+    end
+    
+    def attach(data)
+      self.attachment = Base64.encode64(data)
+    end
+    
+    def destroy
+      connection.delete(element_path(prefix_options.merge(:asset => {:key => key})), self.class.headers)
+    end
+    
+    def new?
+      false
+    end
+    
+    def method_missing(method_symbol, *arguments) #:nodoc:
+      if %w{value= attachment= src= source_key=}.include?(method_symbol)
+        wipe_value_attributes
+      end
+      super
+    end
+    
+    private
+    
+    def wipe_value_attributes
+      %w{value attachment src source_key}.each do |attr|
+        attributes.delete(attr)
+      end
+    end
+  end
+end