dcparker-shopify 0.1.0

data/CHANGELOG

@@ -0,0 +1 @@
+v0.1.0 First release, a rewrite of Shopify's own Rails plugin, turned into a gem with similar workings.

data/Manifest

@@ -0,0 +1,13 @@
+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

data/README

@@ -0,0 +1,9 @@
+Example Usage:
+
+	Shopify.current_session = Shopify::Session.new('store_name', 'api-key', 'api-secret')
+	Shopify.current_session.token = 'api-session-token'
+	Shopify.apply_current_session!
+
+	Shopify::Shop.current
+	Shopify::Product.find(:first)
+	Shopify::Order.find(:first)

data/lib/shopify.rb

@@ -0,0 +1,93 @@
+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 ||= []
+    end
+
+    # Returns the last session on the sessions stack.
+    def current_session
+      sessions.last
+    end
+
+    # Sets the current_session / appends a session to the sessions stack.
+    def current_session=(session)
+      sessions << session
+    end
+
+    # Injects the generated site (with basic auth params) into the ActiveResource::Base subclasses.
+    def apply_current_session!
+      current_session.apply!
+    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
+    end
+  end
+end
+
+# To fix a silly bug in ActiveResource loading... :(
+module Enumerable # :nodoc: all
+  def group_by
+  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
+    end
+  end
+end

data/lib/shopify/address.rb

@@ -0,0 +1,17 @@
+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

@@ -0,0 +1,36 @@
+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

@@ -0,0 +1,45 @@
+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

@@ -0,0 +1,11 @@
+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

@@ -0,0 +1,83 @@
+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

@@ -0,0 +1,8 @@
+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

@@ -0,0 +1,14 @@
+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

data/shopify.gemspec

@@ -0,0 +1,37 @@
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{shopify}
+  s.version = "0.1.0"
+
+  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.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.has_rdoc = true
+  s.homepage = %q{http://github.com/dcparker/shopify/tree}
+  s.rdoc_options = ["--line-numbers", "--inline-source", "--title", "Shopify", "--main", "README"]
+  s.require_paths = ["lib"]
+  s.rubyforge_project = %q{shopify}
+  s.rubygems_version = %q{1.3.1}
+  s.summary = %q{Easily communicate with Shopify.com's restful API.}
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    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

@@ -0,0 +1,100 @@
+--- !ruby/object:Gem::Specification 
+name: dcparker-shopify
+version: !ruby/object:Gem::Version 
+  version: 0.1.0
+platform: ruby
+authors: 
+- Daniel Parker
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2008-12-10 00:00:00 -08: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
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+    version: 
+description: Easily communicate with Shopify.com's restful API.
+email: gems@behindlogic.com
+executables: []
+
+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.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.rb
+- LICENSE
+- Manifest
+- README
+- shopify.gemspec
+has_rdoc: true
+homepage: http://github.com/dcparker/shopify/tree
+post_install_message: 
+rdoc_options: 
+- --line-numbers
+- --inline-source
+- --title
+- Shopify
+- --main
+- README
+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: "1.2"
+  version: 
+requirements: []
+
+rubyforge_project: shopify
+rubygems_version: 1.2.0
+signing_key: 
+specification_version: 2
+summary: Easily communicate with Shopify.com's restful API.
+test_files: []
+