th_shopify_api 1.2.6.pre

data/lib/shopify_api/resources/base.rb

@@ -0,0 +1,5 @@
+module ShopifyAPI
+  class Base < ActiveResource::Base
+    extend Countable
+  end
+end

data/lib/shopify_api/resources/billing_address.rb

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

data/lib/shopify_api/resources/blog.rb

@@ -0,0 +1,10 @@
+module ShopifyAPI
+  class Blog < Base
+    include Events
+    include Metafields
+
+    def articles
+      Article.find(:all, :params => { :blog_id => id })
+    end
+  end
+end

data/lib/shopify_api/resources/cli.rb

@@ -0,0 +1,161 @@
+require 'thor'
+require 'abbrev'
+
+module ShopifyAPI
+  class Cli < Thor
+    include Thor::Actions
+    
+    class ConfigFileError < StandardError
+    end
+
+    desc "list", "list available connections"
+    def list
+      available_connections.each do |c|
+        prefix = default?(c) ? " * " : "   "
+        puts prefix + c
+      end
+    end
+    
+    desc "add CONNECTION", "create a config file for a connection named CONNECTION"
+    def add(connection)
+      file = config_file(connection)
+      if File.exist?(file)
+        raise ConfigFileError, "There is already a config file at #{file}"
+      else
+        config = {'protocol' => 'https'}
+        config['domain']   = ask("Domain? (leave blank for #{connection}.myshopify.com)")
+        config['domain']   = "#{connection}.myshopify.com" if config['domain'].blank?
+        puts "\nopen https://#{config['domain']}/admin/api in your browser to get API credentials\n"
+        config['api_key']  = ask("API key?")
+        config['password'] = ask("Password?")
+        create_file(file, config.to_yaml)
+      end
+      if available_connections.one?
+        default(connection)
+      end
+    end
+    
+    desc "remove CONNECTION", "remove the config file for CONNECTION"
+    def remove(connection)
+      file = config_file(connection)
+      if File.exist?(file)
+        remove_file(default_symlink) if default?(connection)
+        remove_file(file)
+      else
+        no_config_file_error(file)
+      end
+    end
+    
+    desc "edit [CONNECTION]", "open the config file for CONNECTION with your default editor"
+    def edit(connection=nil)
+      file = config_file(connection)
+      if File.exist?(file)
+        if ENV['EDITOR'].present?
+          system(ENV['EDITOR'], file)
+        else
+          puts "Please set an editor in the EDITOR environment variable"
+        end
+      else
+        no_config_file_error(file)
+      end
+    end
+    
+    desc "show [CONNECTION]", "output the location and contents of the CONNECTION's config file"
+    def show(connection=nil)
+      connection ||= default_connection
+      file = config_file(connection)
+      if File.exist?(file)
+        puts file
+        puts `cat #{file}`
+      else
+        no_config_file_error(file)
+      end
+    end
+    
+    desc "default [CONNECTION]", "show the default connection, or make CONNECTION the default"
+    def default(connection=nil)
+      if connection
+        target = config_file(connection)
+        if File.exist?(target)
+          remove_file(default_symlink)
+          `ln -s #{target} #{default_symlink}`
+        else
+          no_config_file_error(target)
+        end
+      end
+      if File.exist?(default_symlink)
+        puts "Default connection is #{default_connection}"
+      else
+        puts "There is no default connection set"
+      end
+    end
+    
+    desc "console [CONNECTION]", "start an API console for CONNECTION"
+    def console(connection=nil)
+      file = config_file(connection)
+      
+      config = YAML.load(File.read(file))
+      puts "using #{config['domain']}"
+      ShopifyAPI::Base.site = site_from_config(config)
+      
+      require 'irb'
+      require 'irb/completion'
+      ARGV.clear
+      IRB.start
+    end
+
+    tasks.keys.abbrev.each do |shortcut, command|
+      map shortcut => command.to_sym
+    end
+
+    private
+    
+    def shop_config_dir
+      @shop_config_dir ||= File.join(ENV['HOME'], '.shopify', 'shops')
+    end
+    
+    def default_symlink
+      @default_symlink ||= File.join(shop_config_dir, 'default')
+    end
+    
+    def config_file(connection)
+      if connection
+        File.join(shop_config_dir, "#{connection}.yml")
+      else
+        default_symlink
+      end
+    end
+    
+    def site_from_config(config)
+      protocol = config['protocol'] || 'https'
+      api_key  = config['api_key']
+      password = config['password']
+      domain   = config['domain']
+    
+      ShopifyAPI::Base.site = "#{protocol}://#{api_key}:#{password}@#{domain}/admin"
+    end
+    
+    def available_connections
+      @available_connections ||= begin
+        pattern = File.join(shop_config_dir, "*.yml")
+        Dir.glob(pattern).map { |f| File.basename(f, ".yml") }
+      end
+    end
+    
+    def default_connection_target
+      @default_connection_target ||= File.readlink(default_symlink)
+    end
+    
+    def default_connection
+      @default_connection ||= File.basename(default_connection_target, ".yml")
+    end
+    
+    def default?(connection)
+      default_connection == connection
+    end
+    
+    def no_config_file_error(filename)
+      raise ConfigFileError, "There is no config file at #{filename}"
+    end
+  end
+end

data/lib/shopify_api/resources/collect.rb

@@ -0,0 +1,5 @@
+module ShopifyAPI
+  # For adding/removing products from custom collections
+  class Collect < Base
+  end
+end

data/lib/shopify_api/resources/comment.rb

@@ -0,0 +1,13 @@
+module ShopifyAPI
+  class Comment < Base
+    def remove;   load_attributes_from_response(post(:remove, {}, only_id)); end
+    def spam;     load_attributes_from_response(post(:spam, {}, only_id)); end
+    def approve;  load_attributes_from_response(post(:approve, {}, only_id)); end
+    def restore;  load_attributes_from_response(post(:restore, {}, only_id)); end
+    def not_spam; load_attributes_from_response(post(:not_spam, {}, only_id)); end
+
+    def only_id
+      encode(:only => :id)
+    end
+  end
+end

data/lib/shopify_api/resources/countable.rb

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

data/lib/shopify_api/resources/country.rb

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

data/lib/shopify_api/resources/custom_collection.rb

@@ -0,0 +1,19 @@
+module ShopifyAPI
+  class CustomCollection < Base
+    include Events
+    include Metafields
+
+    def products
+      Product.find(:all, :params => {:collection_id => self.id})
+    end
+    
+    def add_product(product)
+      Collect.create(:collection_id => self.id, :product_id => product.id)
+    end
+    
+    def remove_product(product)
+      collect = Collect.find(:first, :params => {:collection_id => self.id, :product_id => product.id})
+      collect.destroy if collect
+    end
+  end                                                                 
+end

data/lib/shopify_api/resources/customer.rb

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

data/lib/shopify_api/resources/customer_group.rb

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

data/lib/shopify_api/resources/event.rb

@@ -0,0 +1,10 @@
+module ShopifyAPI
+  class Event < Base
+    self.prefix = "/admin/:resource/:resource_id/"
+    
+    # Hack to allow both Shop and other Events in through the same AR class
+    def self.prefix(options={})
+      options[:resource].nil? ? "/admin/" : "/admin/#{options[:resource]}/#{options[:resource_id]}/"
+    end
+  end
+end

data/lib/shopify_api/resources/fulfillment.rb

@@ -0,0 +1,5 @@
+module ShopifyAPI
+  class Fulfillment < Base
+    self.prefix = "/admin/orders/:order_id/"
+  end
+end

data/lib/shopify_api/resources/image.rb

@@ -0,0 +1,16 @@
+module ShopifyAPI
+  class Image < Base
+    self.prefix = "/admin/products/:product_id/"
+    
+    # generate a method for each possible image variant
+    [:pico, :icon, :thumb, :small, :compact, :medium, :large, :grande, :original].each do |m|
+      reg_exp_match = "/\\1_#{m}.\\2"
+      define_method(m) { src.gsub(/\/(.*)\.(\w{2,4})/, reg_exp_match) }
+    end
+    
+    def attach_image(data, filename = nil)
+      attributes['attachment'] = Base64.encode64(data)
+      attributes['filename'] = filename unless filename.nil?
+    end
+  end
+end

data/lib/shopify_api/resources/line_item.rb

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

data/lib/shopify_api/resources/metafield.rb

@@ -0,0 +1,15 @@
+module ShopifyAPI
+  class Metafield < Base
+    self.prefix = "/admin/:resource/:resource_id/"
+    
+    # Hack to allow both Shop and other Metafields in through the same AR class
+    def self.prefix(options={})
+      options[:resource].nil? ? "/admin/" : "/admin/#{options[:resource]}/#{options[:resource_id]}/"
+    end
+            
+    def value
+      return if attributes["value"].nil?
+      attributes["value_type"] == "integer" ? attributes["value"].to_i : attributes["value"]
+    end
+  end
+end

data/lib/shopify_api/resources/note_attribute.rb

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

data/lib/shopify_api/resources/option.rb

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

data/lib/shopify_api/resources/order.rb

@@ -0,0 +1,25 @@
+module ShopifyAPI
+  class Order < Base
+    include Events
+    include Metafields
+
+    def close;  load_attributes_from_response(post(:close, {}, only_id)); end
+    def open;   load_attributes_from_response(post(:open, {}, only_id)); end
+
+    def cancel(options = {})
+      load_attributes_from_response(post(:cancel, options, only_id))
+    end
+
+    def transactions
+      Transaction.find(:all, :params => { :order_id => id })
+    end
+
+    def capture(amount = "")
+      Transaction.create(:amount => amount, :kind => "capture", :order_id => id)
+    end
+
+    def only_id
+      encode(:only => :id, :include => [], :methods => [], :fields => [])
+    end
+  end
+end

data/lib/shopify_api/resources/page.rb

@@ -0,0 +1,6 @@
+module ShopifyAPI
+  class Page < Base
+    include Events
+    include Metafields
+  end
+end

data/lib/shopify_api/resources/payment_details.rb

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

data/lib/shopify_api/resources/product.rb

@@ -0,0 +1,33 @@
+module ShopifyAPI
+  class Product < Base
+    include Events
+    include Metafields
+
+    # 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
+    
+    def collections
+      CustomCollection.find(:all, :params => {:product_id => self.id})
+    end
+    
+    def smart_collections
+      SmartCollection.find(:all, :params => {:product_id => self.id})
+    end
+    
+    def add_to_collection(collection)
+      collection.add_product(self)
+    end
+    
+    def remove_from_collection(collection)
+      collection.remove_product(self)
+    end
+  end
+end

data/lib/shopify_api/resources/product_search_engine.rb

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

data/lib/shopify_api/resources/province.rb

@@ -0,0 +1,5 @@
+module ShopifyAPI
+  class Province < Base
+    self.prefix = "/admin/countries/:country_id/"
+  end
+end

data/lib/shopify_api/resources/receipt.rb

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

data/lib/shopify_api/resources/recurring_application_charge.rb

@@ -0,0 +1,23 @@
+module ShopifyAPI
+  class RecurringApplicationCharge < Base
+    undef_method :test
+    
+    class << self
+      def current
+        all.find { |c| c.status == 'active' }
+      end
+
+      [:pending, :cancelled, :accepted, :declined].each do |status|
+        define_method(status) { all.select { |c| c.status == status.to_s } }
+      end
+    end
+    
+    def cancel
+      load_attributes_from_response(self.destroy)
+    end
+    
+    def activate
+      load_attributes_from_response(post(:activate))
+    end
+  end
+end

data/lib/shopify_api/resources/redirect.rb

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