shopify 0.3.0

data/.document

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

data/.gitignore

@@ -0,0 +1,21 @@
+## MAC OS
+.DS_Store
+
+## TEXTMATE
+*.tmproj
+tmtags
+
+## EMACS
+*~
+\#*
+.\#*
+
+## VIM
+*.swp
+
+## PROJECT::GENERAL
+coverage
+rdoc
+pkg
+
+## PROJECT::SPECIFIC

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 BehindLogic
+
+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.markdown

@@ -0,0 +1,39 @@
+# shopify
+
+## Links
+
+* Gem: [http://gemcutter.org/gems/shopify](http://gemcutter.org/gems/shopify)
+* Source: [http://github.com/dcparker/shopify](http://github.com/dcparker/shopify)
+* Author: [Daniel Parker](http://github.com/dcparker) from [BehindLogic](http://behindlogic.com)
+* Shopify API Documentation: [http://api.shopify.com/](http://api.shopify.com/)
+
+## Features
+
+* Read any kind of data from Shopify, but no support built-in yet to save data back to Shopify.
+* Thread-safe: You can connect to multiple shops in the same application.
+
+## Example Usage:
+
+    shop = Shopify.new('store_name', 'api-key', 'api-secret', 'auth-token')
+    order = shop.orders(:limit => 1)[0] # => gets first order
+    order.line_items                    # => the line items within that order
+    order.fulfillments                  # => gets all fulfillments related to this order
+    blogs = shop.blogs                  # => gets all blogs for this shop
+    articles = blogs[0].articles        # => gets all the articles in this blog
+    articles[0].comments                # => gets the comments for that article
+    shop.products                       # => get all products in this shop
+    ... and much more ... :)
+
+## Note on Patches/Pull Requests
+ 
+* Fork the project.
+* Make your feature addition or bug fix.
+* Add tests for it. This is important so I don't break it in a
+  future version unintentionally.
+* Commit, do not mess with rakefile, version, or history.
+  (if you want to have your own version, that is fine but bump version in a commit by itself I can ignore when I pull)
+* Send me a pull request. Bonus points for topic branches.
+
+## Copyright
+
+Copyright (c) 2009 BehindLogic. See LICENSE for details.

data/Rakefile

@@ -0,0 +1,54 @@
+require 'rubygems'
+require 'rake'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "shopify"
+    gem.summary = %Q{Communicate easily with Shopify.com's Restful API.}
+    gem.description = %Q{Communicate easily with Shopify.com's Restful API.}
+    gem.email = "gems@behindlogic.com"
+    gem.homepage = "http://github.com/dcparker/shopify"
+    gem.authors = ["BehindLogic"]
+    gem.add_dependency "extlib", ">= 0"
+    gem.add_dependency "httparty", ">= 0.5.0"
+    # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
+  end
+  Jeweler::GemcutterTasks.new
+rescue LoadError
+  puts "Jeweler (or a dependency) not available. Install it with: gem install jeweler"
+end
+
+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 :test => :check_dependencies
+
+task :default => :test
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "shopify #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+0.3.0

data/lib/shopify.rb

@@ -0,0 +1,178 @@
+require 'bigdecimal'
+require 'digest/md5'
+require 'extlib'
+require 'httparty'
+
+
+# Class: Shopify
+# Usage:
+#   shop = Shopify.new(host, [key, [secret, [token]]])
+#   shop.orders
+class Shopify
+  attr_reader :host
+  include HTTParty
+
+  def initialize(host, key=nil, secret=nil, token=nil)
+    host.gsub!(/https?:\/\//, '') # remove http(s)://
+    @host = host.include?('.') ? host : "#{host}.myshopify.com" # extend url to myshopify.com if no host is given
+    @key    = key
+    @secret = secret
+    @token  = token
+    setup
+  end
+
+  def needs_authorization?
+    ![@host, @key, @secret, @token].all?
+  end
+
+  def authorize!(token)
+    @token = token
+    setup
+  end
+
+  def authorization_url(mode='w')
+    "http://#{@host}/admin/api/auth?api_key=#{@key}&mode=#{mode}"
+  end
+
+  def setup
+    unless needs_authorization?
+      @base_uri = "http://#{@host}/admin"
+      @basic_auth = {:username => @key, :password => Digest::MD5.hexdigest("#{@secret.chomp}#{@token.chomp}")}
+      @format = :xml
+    end
+  end
+  private :setup
+
+  def options(opts={})
+    {:base_uri => @base_uri, :basic_auth => @basic_auth, :format => @format}.merge(opts)
+  end
+
+
+  class ShopifyModel
+    class << self
+      def load_api_classes(api)
+        api.each_key do |klass_name|
+          next unless klass_name.is_a?(String)
+          mode = []
+          singular = klass_name.singular
+          mode = [:singular] if singular == klass_name
+          klass = Shopify.const_set(singular, Class.new(ShopifyModel))
+
+          # Set up the top_level or children_of setting
+          self == ShopifyModel ?
+            klass.send(:top_level, *mode) :
+            klass.send(:children_of, self)
+
+          # Set up the properties
+          klass.send(:attr_accessor, *api[klass_name].delete(:properties).split(', ').map {|s| s.to_sym})
+          
+          # If there are any children to be had, set them up
+          klass.load_api_classes(api[klass_name])
+        end
+      end
+
+      def top_level(*options)
+        klass_name = self.name.gsub(/.*::/,'')
+        if options.include?(:singular)
+          # Defines the singular accessor in the Shopify object
+          # TODO: Make the object cache the results of queries, per set of parameters,
+          #       and reload only when you include true as the first argument.
+          Shopify.class_eval "
+            def #{klass_name.snake_case}(query_params={})
+              json = Shopify.get(\"/#{klass_name.snake_case}.xml\", options(:query => query_params))
+              begin
+                #{klass_name}.instantiate(self, json['#{klass_name.snake_case}'])
+              rescue => e
+                warn \"Error: \#{e.inspect}\"
+                json
+              end
+            end
+          "
+        else
+          # Defines the plural accessor in the Shopify object
+          # TODO: Make the object cache the results of queries, per set of parameters,
+          #       and reload only when you include true as the first argument.
+          Shopify.class_eval "
+            def #{klass_name.snake_case.pluralize}(query_params={})
+              json = Shopify.get(\"/#{klass_name.snake_case.pluralize}.xml\", options(:query => query_params))
+              if json['#{klass_name.snake_case.pluralize}']
+                json['#{klass_name.snake_case.pluralize}'].collect {|i| #{klass_name}.instantiate(self, i)}
+              else
+                json
+              end
+            end
+            def #{klass_name.snake_case}(id)
+              json = Shopify.get(\"/#{klass_name.snake_case.pluralize}/\#{id}.xml\", options)
+              if json['#{klass_name.snake_case}']
+                #{klass_name}.instantiate(self, json['#{klass_name.snake_case}'])
+              else
+                json
+              end
+            end
+          "
+        end
+      end
+      def children_of(parent_klass)
+        @parent = parent_klass
+        parent_klass_name = parent_klass.name.gsub(/.*::/,'')
+        klass_name = self.name.gsub(/.*::/,'')
+        # Defines the getter method in the parent class
+        # TODO: Make the object cache the results of queries, per set of parameters,
+        #       and reload only when you include true as the first argument.
+        parent_klass.class_eval "
+          def #{klass_name.snake_case.pluralize}(query_params={})
+            @#{klass_name.snake_case.pluralize} ||= begin
+              json = Shopify.get(\"/#{parent_klass_name.snake_case.pluralize}/\#{id}/#{klass_name.snake_case.pluralize}.xml\", shop.options(:query => query_params))
+              case 
+              when json['#{parent_klass_name.snake_case}_#{klass_name.snake_case.pluralize}']
+                json['#{parent_klass_name.snake_case}_#{klass_name.snake_case.pluralize}']
+              when json['#{klass_name.snake_case.pluralize}']
+                json['#{klass_name.snake_case.pluralize}']
+              else
+                json
+              end
+            end
+            @#{klass_name.snake_case.pluralize} = (@#{klass_name.snake_case.pluralize}.is_a?(Array) ? @#{klass_name.snake_case.pluralize}.collect {|i| #{klass_name}.instantiate(shop, i)} : [#{klass_name}.instantiate(shop, @#{klass_name.snake_case.pluralize})]) unless @#{klass_name.snake_case.pluralize}.is_a?(#{klass_name}) || @#{klass_name.snake_case.pluralize}.is_a?(Array) && @#{klass_name.snake_case.pluralize}[0].is_a?(#{klass_name})
+            @#{klass_name.snake_case.pluralize}
+          end
+        "
+      end
+      def is_child?
+        (@parent ||= nil)
+      end
+    end
+
+    def self.instantiate(shop, attrs={})
+      new(shop, attrs.merge('new_record' => false))
+    end
+    def initialize(shop, attrs={})
+      @new_record = true
+      attrs.each { |k,v| instance_variable_set("@#{k}", v) }
+      @shop = shop
+    end
+    attr_accessor :shop
+
+    def inspect
+      "<#{self.class.name} shop=#{@shop.host} #{instance_variables.reject {|i| i=='@shop' || instance_variable_get(i).to_s==''}.map {|i| "#{i}=#{instance_variable_get(i).inspect}"}.join(' ')}>"
+    end
+  end
+
+
+  ########################################
+  ##  Load the Shopify Object Classes!  ##
+  ########################################
+  ShopifyModel.load_api_classes YAML.load_file(File.dirname(__FILE__)+'/shopify_api.yml')
+
+
+  # Add some extra touches to a couple of the models
+  class Article < ShopifyModel
+    def comments(query_params={})
+      shop.comments(query_params.merge(:article_id => id, :blog_id => blog_id))
+    end
+  end
+  class CustomCollection < ShopifyModel
+    def products(query_params={})
+      shop.products(query_params.merge(:collection_id => id))
+    end
+  end
+end

data/lib/shopify/support.rb

@@ -0,0 +1,110 @@
+require 'extlib'
+require 'bigdecimal'
+require 'digest/md5'
+require 'httparty'
+
+class Shopify
+  class ShopifyModel
+    class << self
+      def load_api_classes(api)
+        api.each_key do |klass_name|
+          next unless klass_name.is_a?(String)
+          mode = []
+          singular = klass_name.singular
+          mode = [:singular] if singular == klass_name
+          klass = Shopify.const_set(singular, Class.new(ShopifyModel))
+
+          # Set up the top_level or children_of setting
+          if self == ShopifyModel
+            klass.send(:top_level, *mode)
+          else
+            klass.send(:children_of, self)
+          end
+
+          # Set up the properties
+          klass.send(:attr_accessor, *api[klass_name].delete(:properties).split(', ').map {|s| s.to_sym})
+          
+          # If there are any children to be had, set them up
+          klass.load_api_classes(api[klass_name])
+        end
+      end
+
+      def top_level(*options)
+        klass_name = self.name.gsub(/.*::/,'')
+        if options.include?(:singular)
+          # Define singular accessor in Shopify
+          Shopify.class_eval "
+            def #{klass_name.snake_case}(query_params={})
+              json = Shopify.get(\"/#{klass_name.snake_case}.xml\", options(:query => query_params))
+              begin
+                #{klass_name}.instantiate(self, json['#{klass_name.snake_case}'])
+              rescue => e
+                warn \"Error: \#{e.inspect}\"
+                json
+              end
+            end
+          "
+        else
+          # Define plural accessor in Shopify
+          Shopify.class_eval "
+            def #{klass_name.snake_case.pluralize}(query_params={})
+              json = Shopify.get(\"/#{klass_name.snake_case.pluralize}.xml\", options(:query => query_params))
+              if json['#{klass_name.snake_case.pluralize}']
+                json['#{klass_name.snake_case.pluralize}'].collect {|i| #{klass_name}.instantiate(self, i)}
+              else
+                json
+              end
+            end
+            def #{klass_name.snake_case}(id)
+              json = Shopify.get(\"/#{klass_name.snake_case.pluralize}/\#{id}.xml\", options)
+              if json['#{klass_name.snake_case}']
+                #{klass_name}.instantiate(self, json['#{klass_name.snake_case}'])
+              else
+                json
+              end
+            end
+          "
+        end
+      end
+      def children_of(parent_klass)
+        @parent = parent_klass
+        parent_klass_name = parent_klass.name.gsub(/.*::/,'')
+        klass_name = self.name.gsub(/.*::/,'')
+        parent_klass.class_eval "
+          def #{klass_name.snake_case.pluralize}(query_params={})
+            @#{klass_name.snake_case.pluralize} ||= begin
+              json = Shopify.get(\"/#{parent_klass_name.snake_case.pluralize}/\#{id}/#{klass_name.snake_case.pluralize}.xml\", shop.options(:query => query_params))
+              case 
+              when json['#{parent_klass_name.snake_case}_#{klass_name.snake_case.pluralize}']
+                json['#{parent_klass_name.snake_case}_#{klass_name.snake_case.pluralize}']
+              when json['#{klass_name.snake_case.pluralize}']
+                json['#{klass_name.snake_case.pluralize}']
+              else
+                json
+              end
+            end
+            @#{klass_name.snake_case.pluralize} = (@#{klass_name.snake_case.pluralize}.is_a?(Array) ? @#{klass_name.snake_case.pluralize}.collect {|i| #{klass_name}.instantiate(shop, i)} : [#{klass_name}.instantiate(shop, @#{klass_name.snake_case.pluralize})]) unless @#{klass_name.snake_case.pluralize}.is_a?(#{klass_name}) || @#{klass_name.snake_case.pluralize}.is_a?(Array) && @#{klass_name.snake_case.pluralize}[0].is_a?(#{klass_name})
+            @#{klass_name.snake_case.pluralize}
+          end
+        "
+      end
+      def is_child?
+        (@parent ||= nil)
+      end
+    end
+
+    def self.instantiate(shop, attrs={})
+      new(shop, attrs.merge('new_record' => false))
+    end
+    def initialize(shop, attrs={})
+      @new_record = true
+      attrs.each { |k,v| instance_variable_set("@#{k}", v) }
+      @shop = shop
+    end
+    attr_accessor :shop
+
+    def inspect
+      "<#{self.class.name} shop=#{@shop.host} #{instance_variables.reject {|i| i=='@shop' || instance_variable_get(i).to_s==''}.map {|i| "#{i}=#{instance_variable_get(i).inspect}"}.join(' ')}>"
+    end
+  end
+end

data/lib/shopify_api.yml

@@ -0,0 +1,35 @@
+---
+Blogs:
+  :properties: commentable, feedburner, feedburner_locations, handle, id, shop_id, title, updated_at
+  Articles:
+    :properties: author, blog_id, body, body_html, created_at, id, published_at, title, updated_at
+Comments:
+  :properties: article_id, author, blog_id, body, body_html, created_at, email, id, ip, published_at, shop_id, status, updated_at, user_agent
+Collects:
+  :properties: collection_id, featured, id, position, product_id
+Countries:
+  :properties: code, id, name, tax
+  Provinces:
+    :properties: code, id, name, tax
+CustomCollections:
+  :properties: body, body_html, handle, id, published_at, sort_order, title, updated_at
+Orders:
+  :properties: buyer_accepts_marketing, closed_at, created_at, currency, email, financial_status, fulfillment_status, gateway, id, name, note, number, subtotal_price, taxes_included, token, total_discounts, total_line_items_price, total_price, total_tax, total_weight, updated_at, browser_ip, billing_address, shipping_address, line_items, shipping_line
+  LineItems:
+    :properties: fulfillment_service, grams, id, price, quantity, sku, title, variant_id, vendor, name, product_title
+  Fulfillments:
+    :properties: id, order_id, status, tracking_number, line_items, receipt
+  Transactions:
+    :properties: amount, authorization, created_at, kind, order_id, status, receipt
+Pages:
+  :properties: author, body, body_html, created_at, handle, ip, published_at, shop_id, title, updated_at
+Products:
+  :properties: body, body_html, created_at, handle, id, product_type, published_at, title, updated_at, vendor, tags, variants, images
+  Images:
+    :properties: id, position, product_id, src
+  Variants:
+    :properties: compare_at_price, fulfillment_service, grams, id, inventory_management, inventory_policy, inventory_quantity, position, price, product_id, sku, title
+Redirects:
+  :properties: id, path, shop_id, target
+Shop:
+  :properties: active_subscription_id, address1, city, country, created_at, domain, email, id, name, phone, province, public, source, zip, taxes_included, currency, timezone, shop_owner

data/test/helper.rb

@@ -0,0 +1,10 @@
+require 'rubygems'
+require 'test/unit'
+require 'shoulda'
+
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+require 'shopify'
+
+class Test::Unit::TestCase
+end

data/test/test_shopify.rb

@@ -0,0 +1,7 @@
+require 'helper'
+
+class TestShopify < Test::Unit::TestCase
+  should "probably rename this file and start testing for real" do
+    flunk "hey buddy, you should probably rename this file and start testing for real"
+  end
+end

metadata

@@ -0,0 +1,86 @@
+--- !ruby/object:Gem::Specification 
+name: shopify
+version: !ruby/object:Gem::Version 
+  version: 0.3.0
+platform: ruby
+authors: 
+- BehindLogic
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-12-17 00:00:00 -05:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: extlib
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: httparty
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 0.5.0
+    version: 
+description: Communicate easily with Shopify.com's Restful API.
+email: gems@behindlogic.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+- README.markdown
+files: 
+- .document
+- .gitignore
+- LICENSE
+- README.markdown
+- Rakefile
+- VERSION
+- lib/shopify.rb
+- lib/shopify/support.rb
+- lib/shopify_api.yml
+- test/helper.rb
+- test/test_shopify.rb
+has_rdoc: true
+homepage: http://github.com/dcparker/shopify
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.5
+signing_key: 
+specification_version: 3
+summary: Communicate easily with Shopify.com's Restful API.
+test_files: 
+- test/helper.rb
+- test/test_shopify.rb