shopify_api 1.2.5 → 2.0.0

data/lib/shopify_api/cli.rb

@@ -8,10 +8,6 @@ module ShopifyAPI
     class ConfigFileError < StandardError
     end
 
-    tasks.keys.abbrev.each do |shortcut, command|
-      map shortcut => command.to_sym
-    end
-    
     desc "list", "list available connections"
     def list
       available_connections.each do |c|
@@ -55,7 +51,7 @@ module ShopifyAPI
       file = config_file(connection)
       if File.exist?(file)
         if ENV['EDITOR'].present?
-          `#{ENV['EDITOR']} #{file}`
+          system(ENV['EDITOR'], file)
         else
           puts "Please set an editor in the EDITOR environment variable"
         end
@@ -84,7 +80,7 @@ module ShopifyAPI
           remove_file(default_symlink)
           `ln -s #{target} #{default_symlink}`
         else
-          no_config_file_error(file)
+          no_config_file_error(target)
         end
       end
       if File.exist?(default_symlink)
@@ -107,7 +103,11 @@ module ShopifyAPI
       ARGV.clear
       IRB.start
     end
-    
+
+    tasks.keys.abbrev.each do |shortcut, command|
+      map shortcut => command.to_sym
+    end
+
     private
     
     def shop_config_dir
@@ -155,7 +155,7 @@ module ShopifyAPI
     end
     
     def no_config_file_error(filename)
-      raise ConfigFileError, "There is no config file at #{file}"
+      raise ConfigFileError, "There is no config file at #{filename}"
     end
   end
-end
+end

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/json_format.rb

@@ -0,0 +1,23 @@
+module ActiveResource
+  class Base
+    def encode(options = {})
+      same = dup
+      same.attributes = {self.class.element_name => same.attributes} if self.class.format.extension == 'json'
+
+      same.send("to_#{self.class.format.extension}", options)
+    end
+  end
+
+  module Formats
+    module JsonFormat
+      def decode(json)
+        data = ActiveSupport::JSON.decode(json)
+        if data.is_a?(Hash) && data.keys.size == 1
+          data.values.first
+        else
+          data
+        end
+      end
+    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

data/lib/shopify_api/resources/base.rb

@@ -0,0 +1,6 @@
+module ShopifyAPI
+  class Base < ActiveResource::Base
+    extend Countable
+    self.include_root_in_json = false
+  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/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/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