dcparker-shopify 0.1.0 → 0.1.9

data/CHANGELOG

@@ -1 +1,2 @@
 v0.1.0 First release, a rewrite of Shopify's own Rails plugin, turned into a gem with similar workings.
+v0.1.9 2.0 Beta, another rewrite using the light HTTParty instead of ActiveResource.

data/Manifest

@@ -1,11 +1,5 @@
 CHANGELOG
-lib/shopify/address.rb
-lib/shopify/order.rb
-lib/shopify/product.rb
-lib/shopify/sale.rb
-lib/shopify/session.rb
-lib/shopify/shop.rb
-lib/shopify/site.rb
+lib/shopify/support.rb
 lib/shopify.rb
 LICENSE
 Manifest

data/lib/shopify.rb

@@ -1,93 +1,149 @@
+include_path = File.expand_path(File.dirname(__FILE__))
+$:.unshift(include_path) unless $:.include?(include_path)
+require 'shopify/support'
+
 module Shopify
-  autoload :Session,          'shopify/session'
-  autoload :Shop,             'shopify/shop'
-  autoload :Product,          'shopify/product'
-  autoload :Variant,          'shopify/product'
-  autoload :Image,            'shopify/product'
-  autoload :Order,            'shopify/order'
-  autoload :LineItem,         'shopify/order'
-  autoload :ShippingLine,     'shopify/order'
-  autoload :CustomCollection, 'shopify/order'
-  autoload :ShippingAddress,  'shopify/address'
-  autoload :BillingAddress,   'shopify/address'
-  autoload :Country,          'shopify/address'
-  autoload :Province,         'shopify/address'
-  autoload :Sale,             'shopify/sale'
-  autoload :Authorization,    'shopify/sale'
-  autoload :Payment,          'shopify/sale'
-  autoload :Page,             'shopify/site'
-  autoload :Blog,             'shopify/site'
-  autoload :Article,          'shopify/site'
-
-  class << self
-    attr_reader :key, :secret
-
-    # Lists the session stack.
-    def sessions
-      @sessions ||= []
+  include HTTParty
+
+  def self.setup(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
+    if [host, key, secret, token].all?
+      base_uri "http://#{@host}/admin"
+      basic_auth @key, Digest::MD5.hexdigest("#{@secret.chomp}#{@token.chomp}")
+      format :xml
+      return false
+    else
+      "http://#{@host}/admin/api/auth?api_key=#{@key}&mode=#{mode}"
     end
+  end
 
-    # Returns the last session on the sessions stack.
-    def current_session
-      sessions.last
+  # /admin/blogs.xml
+  class Blog < ShopifyModel
+    top_level
+    attr_accessor :commentable, :feedburner, :feedburner_locations, :handle, :id, :shop_id, :title, :updated_at
+    
+    # Get all articles in this blog.
+    def articles
     end
+  end
 
-    # Sets the current_session / appends a session to the sessions stack.
-    def current_session=(session)
-      sessions << session
+  # /admin/blogs/[blog_id]/articles.xml
+  class Article < ShopifyModel
+    child_of Blog
+    attr_accessor :author, :blog_id, :body, :body_html, :created_at, :id, :published_at, :title, :updated_at
+    def comments(query_params={})
+      Shopify.comments(query_params.merge(:article_id => id, :blog_id => blog_id))
     end
+  end
+
+  # /admin/comments.xml?article_id=*&blog_id=*
+  class Comment < ShopifyModel
+    top_level
+    attr_accessor :article_id, :author, :blog_id, :body, :body_html, :created_at, :email, :id, :ip, :published_at, :shop_id, :status, :updated_at, :user_agent
+  end
+
+  # /admin/collects.xml
+  class Collect < ShopifyModel
+    top_level
+    attr_accessor :collection_id, :featured, :id, :position, :product_id
+  end
 
-    # Injects the generated site (with basic auth params) into the ActiveResource::Base subclasses.
-    def apply_current_session!
-      current_session.apply!
+  # /admin/countries.xml
+  class Country < ShopifyModel
+    top_level
+    attr_accessor :code, :id, :name, :tax
+
+    # Get all province divisions within this country.
+    def provinces
     end
+  end
 
-    # Perform a block within a specific session, and reset the current session to the previous after execution.
-    def with_session(session,&block)
-      sessions << session
-        apply_current_session!
-        result = yield
-      sessions.pop
-      apply_current_session!
-      return result
+  # /admin/custom_collections.xml
+  class CustomCollection < ShopifyModel
+    top_level
+    attr_accessor :body, :body_html, :handle, :id, :published_at, :sort_order, :title, :updated_at
+    def products(query_params={})
+      Shopify.products(query_params.merge(:collection_id => id))
     end
   end
-end
 
-# To fix a silly bug in ActiveResource loading... :(
-module Enumerable # :nodoc: all
-  def group_by
+  # /admin/orders.xml
+  class Order < ShopifyModel
+    top_level
+    attr_accessor :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
+
+    # Get all fulfillments related to this order.
+    def fulfillments
+    end
+
+    # Get all transactions related to this order.
+    def transactions
+    end
+  end
+
+  # /admin/orders/[order_id]/fulfillments.xml
+  class Fulfillment < ShopifyModel
+    child_of Order
+    attr_accessor :id, :order_id, :status, :tracking_number, :line_items, :receipt
+  end
+
+  # /admin/pages.xml
+  class Page < ShopifyModel
+    top_level
+    attr_accessor :author, :body, :body_html, :created_at, :handle, :ip, :published_at, :shop_id, :title, :updated_at
   end
-end
 
-# Load ActiveResource
-gem 'activeresource', '>= 2.1.0'
-require 'active_resource'
-module ActiveResource # :nodoc: all
-  class Base
-    class << self
-      def site
-        # Not using superclass_delegating_reader because don't want subclasses to modify superclass instance
-        #
-        # With superclass_delegating_reader
-        #
-        #   Parent.site = 'http://anonymous@test.com'
-        #   Subclass.site # => 'http://anonymous@test.com'
-        #   Subclass.site.user = 'david'
-        #   Parent.site # => 'http://david@test.com'
-        #
-        # Without superclass_delegating_reader (expected behaviour)
-        #
-        #   Parent.site = 'http://anonymous@test.com'
-        #   Subclass.site # => 'http://anonymous@test.com'
-        #   Subclass.site.user = 'david' # => TypeError: can't modify frozen object
-        #
-        if defined?(@site)
-          @site
-        elsif superclass != Object && superclass.site
-          superclass.site.dup.freeze
-        end
-      end
+  # /admin/products.xml?collection_id=*
+  class Product < ShopifyModel
+    top_level
+    attr_accessor :body, :body_html, :created_at, :handle, :id, :product_type, :published_at, :title, :updated_at, :vendor, :tags, :variants, :images
+
+    # Get all images for this product.
+    def images
     end
+
+    # Get all variants of this product.
+    def variant
+    end
+  end
+
+  # /admin/products/[product_id]/images.xml
+  class Image < ShopifyModel
+    child_of Product
+    attr_accessor :id, :position, :product_id, :src
+  end
+
+  # /admin/products/[product_id]/variants.xml
+  class Variant < ShopifyModel
+    child_of Product
+    attr_accessor :compare_at_price, :fulfillment_service, :grams, :id, :inventory_management, :inventory_policy, :inventory_quantity, :position, :price, :product_id, :sku, :title
+  end
+
+  # /admin/countries/[country_id]/provinces.xml
+  class Province < ShopifyModel
+    child_of Country
+    attr_accessor :code, :id, :name, :tax
+  end
+
+  # /admin/redirects.xml
+  class Redirect < ShopifyModel
+    top_level
+    attr_accessor :id, :path, :shop_id, :target
+  end
+
+  # /admin/shop.xml
+  class Shop < ShopifyModel
+    top_level :singular
+    attr_accessor :active_subscription_id, :address1, :city, :country, :created_at, :domain, :email, :id, :name, :phone, :province, :public, :source, :zip, :taxes_included, :currency, :timezone, :shop_owner
+  end
+
+  # /admin/orders/[order_id]/transactions.xml
+  class Transaction < ShopifyModel
+    child_of Order
+    attr_accessor :amount, :authorization, :created_at, :kind, :order_id, :status, :receipt
   end
 end

data/lib/shopify/support.rb

@@ -0,0 +1,104 @@
+require 'rubygems'
+require 'extlib'
+gem 'jnunemaker-httparty', '>=0.3.1'
+require 'httparty'
+require 'bigdecimal'
+require 'digest/md5'
+
+module Shopify
+  def self.get(*args)
+    puts "getting #{args.map {|i| i.inspect}.join(', ')}"
+    super
+  end
+
+  def self.def_collections(*klasses)
+    klasses.each do |klass|
+      kn = klass.name.gsub(/.*::/,'')
+      class_eval "
+        def self.#{kn.snake_case.pluralize}(query_params={})
+          json = get(\"#{klass.site_prefix}/#{kn.snake_case.pluralize}.xml\", :query => query_params)
+          if json['#{kn.snake_case.pluralize}']
+            json['#{kn.snake_case.pluralize}'].collect {|i| #{kn}.instantiate(i)}
+          else
+            json
+          end
+        end
+        def self.#{kn.snake_case}(id)
+          get(\"/#{kn.snake_case.pluralize}/\#{id}.xml\")
+        end
+      "
+    end
+  end
+
+  class ShopifyModel
+    class << self
+      def top_level(*options)
+        klass_name = self.name.gsub(/.*::/,'')
+        if options.include?(:singular)
+          # Define singular accessor in Shopify
+          eval "
+            def Shopify.#{klass_name.snake_case}(query_params={})
+              json = Shopify.get(\"/#{klass_name.snake_case}.xml\", :query => query_params)
+              begin
+                #{klass_name}.instantiate json['#{klass_name.snake_case}']
+              rescue => e
+                warn \"Error: \#{e.inspect}\"
+                json
+              end
+            end
+          "
+        else
+          # Define plural accessor in Shopify
+          eval "
+            def Shopify.#{klass_name.snake_case.pluralize}(query_params={})
+              json = Shopify.get(\"/#{klass_name.snake_case.pluralize}.xml\", :query => query_params)
+              if json['#{klass_name.snake_case.pluralize}']
+                json['#{klass_name.snake_case.pluralize}'].collect {|i| #{klass_name}.instantiate(i)}
+              else
+                json
+              end
+            end
+            def Shopify.#{klass_name.snake_case}(id)
+              json = Shopify.get(\"/#{klass_name.snake_case.pluralize}/\#{id}.xml\")
+              if json['#{klass_name.snake_case}']
+                #{klass_name}.instantiate json['#{klass_name.snake_case}']
+              else
+                json
+              end
+            end
+          "
+        end
+      end
+      def child_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\", :query => query_params)
+              if json['#{parent_klass_name.snake_case}_#{klass_name.snake_case.pluralize}']
+                json['#{parent_klass_name.snake_case}_#{klass_name.snake_case.pluralize}'].collect {|i| #{klass_name}.instantiate(i)}
+              else
+                json
+              end
+            end
+            @#{klass_name.snake_case.pluralize} =  unless @#{klass_name.snake_case.pluralize}.is_a?(#{klass_name})
+            @#{klass_name.snake_case.pluralize}
+          end
+        "
+      end
+      def is_child?
+        (@parent ||= nil)
+      end
+    end
+
+    def self.instantiate(attrs={})
+      new(attrs.merge('new_record' => false))
+    end
+    def initialize(attrs={})
+      @new_record = true
+      attrs.each { |k,v| instance_variable_set("@#{k}", v) }
+    end
+  end
+end

data/shopify.gemspec

@@ -2,15 +2,15 @@
 
 Gem::Specification.new do |s|
   s.name = %q{shopify}
-  s.version = "0.1.0"
+  s.version = "0.1.9"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 1.2") if s.respond_to? :required_rubygems_version=
   s.authors = ["Daniel Parker"]
-  s.date = %q{2008-12-10}
+  s.date = %q{2009-03-10}
   s.description = %q{Easily communicate with Shopify.com's restful API.}
   s.email = %q{gems@behindlogic.com}
-  s.extra_rdoc_files = ["CHANGELOG", "lib/shopify/address.rb", "lib/shopify/order.rb", "lib/shopify/product.rb", "lib/shopify/sale.rb", "lib/shopify/session.rb", "lib/shopify/shop.rb", "lib/shopify/site.rb", "lib/shopify.rb", "LICENSE", "README"]
-  s.files = ["CHANGELOG", "lib/shopify/address.rb", "lib/shopify/order.rb", "lib/shopify/product.rb", "lib/shopify/sale.rb", "lib/shopify/session.rb", "lib/shopify/shop.rb", "lib/shopify/site.rb", "lib/shopify.rb", "LICENSE", "Manifest", "README", "shopify.gemspec"]
+  s.extra_rdoc_files = ["CHANGELOG", "lib/shopify/support.rb", "lib/shopify.rb", "LICENSE", "README"]
+  s.files = ["CHANGELOG", "lib/shopify/support.rb", "lib/shopify.rb", "LICENSE", "Manifest", "README", "shopify.gemspec"]
   s.has_rdoc = true
   s.homepage = %q{http://github.com/dcparker/shopify/tree}
   s.rdoc_options = ["--line-numbers", "--inline-source", "--title", "Shopify", "--main", "README"]
@@ -24,14 +24,11 @@ Gem::Specification.new do |s|
     s.specification_version = 2
 
     if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
-      s.add_runtime_dependency(%q<activeresource>, [">= 0", "= 2.1.0"])
       s.add_development_dependency(%q<echoe>, [">= 0"])
     else
-      s.add_dependency(%q<activeresource>, [">= 0", "= 2.1.0"])
       s.add_dependency(%q<echoe>, [">= 0"])
     end
   else
-    s.add_dependency(%q<activeresource>, [">= 0", "= 2.1.0"])
     s.add_dependency(%q<echoe>, [">= 0"])
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: dcparker-shopify
 version: !ruby/object:Gem::Version 
-  version: 0.1.0
+  version: 0.1.9
 platform: ruby
 authors: 
 - Daniel Parker
@@ -9,23 +9,12 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2008-12-10 00:00:00 -08:00
+date: 2009-03-10 00:00:00 -07:00
 default_executable: 
 dependencies: 
-- !ruby/object:Gem::Dependency 
-  name: activeresource
-  version_requirement: 
-  version_requirements: !ruby/object:Gem::Requirement 
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        version: "0"
-    - - "="
-      - !ruby/object:Gem::Version 
-        version: 2.1.0
-    version: 
 - !ruby/object:Gem::Dependency 
   name: echoe
+  type: :development
   version_requirement: 
   version_requirements: !ruby/object:Gem::Requirement 
     requirements: 
@@ -41,25 +30,13 @@ extensions: []
 
 extra_rdoc_files: 
 - CHANGELOG
-- lib/shopify/address.rb
-- lib/shopify/order.rb
-- lib/shopify/product.rb
-- lib/shopify/sale.rb
-- lib/shopify/session.rb
-- lib/shopify/shop.rb
-- lib/shopify/site.rb
+- lib/shopify/support.rb
 - lib/shopify.rb
 - LICENSE
 - README
 files: 
 - CHANGELOG
-- lib/shopify/address.rb
-- lib/shopify/order.rb
-- lib/shopify/product.rb
-- lib/shopify/sale.rb
-- lib/shopify/session.rb
-- lib/shopify/shop.rb
-- lib/shopify/site.rb
+- lib/shopify/support.rb
 - lib/shopify.rb
 - LICENSE
 - Manifest

data/lib/shopify/address.rb

@@ -1,17 +0,0 @@
-module Shopify
-  class ShippingAddress < ActiveResource::Base
-  end
-
-  class BillingAddress < ActiveResource::Base
-    def name
-      "#{first_name} #{last_name}"
-    end
-  end
-
-  class Country < ActiveResource::Base
-  end
-
-  class Province < ActiveResource::Base
-    self.prefix = "/admin/countries/:country_id/"
-  end
-end

data/lib/shopify/order.rb

@@ -1,36 +0,0 @@
-module Shopify
-  class Order < ActiveResource::Base  
-    def fulfilled?
-      !!fulfillment_status
-    end
-
-    def closed?
-      closed_at < Time.now
-    end
-
-    def close
-      load_attributes_from_response(post(:close))
-    end
-
-    def open
-      load_attributes_from_response(post(:open))
-    end
-
-    def payments
-      Payment.get
-    end
-    
-    def capture(amount=nil)
-      load_attributes_from_response(post(:capture, :amount => amount))
-    end
-  end
-
-  class LineItem < ActiveResource::Base
-  end
-
-  class ShippingLine < ActiveResource::Base
-  end
-
-  class CustomCollection < ActiveResource::Base
-  end
-end

data/lib/shopify/product.rb

@@ -1,45 +0,0 @@
-module Shopify
-  class Product < ActiveResource::Base
-    class << self
-      # Share all items of this store with the shopify marketplace
-      def share_all
-        post :share
-      end
-      # Stop sharing all items of this store with the shopify marketplace
-      def unshare_all
-        delete :share
-      end
-    end
-
-    # Auto-compute the price range
-    def price_range
-      prices = variants.collect(&:price)
-      format =  "%0.2f"
-      if prices.min != prices.max
-        "#{format % prices.min} - #{format % prices.max}"
-      else
-        format % prices.min
-      end
-    end
-  end
-  
-  class Variant < ActiveResource::Base
-    self.prefix = "/admin/products/:product_id/"
-  end
-
-  class Image < ActiveResource::Base
-    self.prefix = "/admin/products/:product_id/"
-    
-    # generate a method for each possible image variant
-    [:pico, :icon, :thumb, :small, :medium, :large, :original].each do |m|
-      reg_exp_match = "/\\1_#{m}.\\2"
-      define_method(m) { src.gsub(/\/(.*)\.(\w{2,4})/, reg_exp_match) }
-    end
-    
-    # Attach an image to a product.
-    def attach_image(data, filename = nil)
-      attributes[:attachment] = Base64.encode64(data)
-      attributes[:filename] = filename unless filename.nil?
-    end
-  end
-end

data/lib/shopify/sale.rb

@@ -1,11 +0,0 @@
-module Shopify
-  class Sale < Payment
-  end
-
-  class Authorization < Payment
-  end
-
-  class Payment < ActiveResource::Base
-    self.prefix = "/admin/orders/:order_id/"
-  end
-end

data/lib/shopify/session.rb

@@ -1,83 +0,0 @@
-require 'digest/md5'
-
-module Shopify
-  # Shopify Session
-  #
-  # Example:
-  #   class LoginController < ApplicationController
-  #     layout 'empty'
-  # 
-  #     before { Shopify.sessions << Shopify::Session.new(session[:store_name] || params[:store_name], session[:shopify_token], SHOPIFY_APP_SECRET) if Shopify.sessions.empty? && (session[:store_name] || params[:store_name]) }
-  #     
-  #     def signin
-  #        # ask user for his myshopify.com address.
-  #     end
-  #   
-  #     # POST to this with the store name
-  #     def login
-  #       # Set the store_name into the session for future requests.
-  #       session[:store_name] = params[:store_name]
-  #       # This will redirect the user to their Shopify store to authorize your application.
-  #       # Shopify will redirect the user back to your :finalize action when finished.
-  #       redirect Shopify.current_session.permission_url
-  #     end
-  #   
-  #     def finalize
-  #       Shopify.current_session.token = params[:t]
-  #       Shopify.apply_current_session!
-  #       if Shopify.current_session.signed_in?
-  #         redirect # logged in area
-  #       else
-  #         flash[:notice] = "Couldn't sign in to your shopify store."
-  #         redirect url(:signin)
-  #       end
-  #     end
-  #   end
-  #    
-  class Session
-    cattr_accessor :protocol
-    self.protocol = 'http'
-
-    attr_accessor :host, :key, :secret, :token
-
-    def initialize(host, key=nil, secret=nil, token=nil)
-      host.gsub!(/https?:\/\//, '') # remove http://
-      host = "#{host}.myshopify.com" unless host.include?('.') # extend url to myshopify.com if no host is given
-
-      self.host   = host
-      self.key    = key
-      self.secret = secret
-      self.token  = token
-    end
-
-    # mode can be either r to request read rights or w to request read/write rights.
-    def permission_url(mode='w')
-      "http://#{host}/admin/api/auth?api_key=#{key}&mode=#{mode}"
-    end
-
-    def apply!
-      ActiveResource::Base.site = site if signed_in?
-    end
-
-    # use this to initialize ActiveResource:
-    # 
-    #  ActiveResource::Base.site = Shopify.current_session.site
-    #
-    def site
-      "#{protocol}://#{key}:#{password}@#{host}/admin"
-    end
-
-    def signed_in?
-      [host, key, secret, token].all?
-    end
-
-    private
-
-    # The secret is computed by taking the shared_secret which we got when 
-    # registring this third party application and concating the request_to it, 
-    # and then calculating a MD5 hexdigest. 
-    def password
-      Digest::MD5.hexdigest("#{secret.chomp}#{token.chomp}")
-    end
-  end
-end

data/lib/shopify/shop.rb

@@ -1,8 +0,0 @@
-module Shopify
-  class Shop
-    # Retrieves information from Shopify about your signed-in shop.
-    def self.current
-      ActiveResource::Base.find(:one, :from => "/admin/shop.xml")
-    end
-  end               
-end

data/lib/shopify/site.rb

@@ -1,14 +0,0 @@
-module Shopify
-  class Page < ActiveResource::Base
-  end
-
-  class Blog < ActiveResource::Base
-    def articles
-      Article.get
-    end
-  end
-
-  class Article < ActiveResource::Base
-    self.prefix = "/admin/blogs/:blog_id/"
-  end
-end