shopify_api 1.1.3 → 1.2.0

data/CHANGELOG

@@ -1,3 +1,8 @@
+== Version 1.2.0
+
+* Command-line interface
+* Allow custom params when fetching a single Asset
+
 == Version 1.1.3 (November 4, 2010)
 
 * Add ProductSearchEngines resource

data/bin/shopify

@@ -0,0 +1,4 @@
+#!/usr/bin/env ruby
+require File.expand_path('../../lib/shopify_api',__FILE__)
+require File.expand_path('../../lib/shopify_api/cli',__FILE__)
+ShopifyAPI::Cli.start(ARGV)

data/lib/shopify_api.rb

@@ -423,7 +423,9 @@ module ShopifyAPI
       if args[0].is_a?(Symbol)
         super
       else
-        find(:one, :from => "/admin/assets.#{format.extension}", :params => {:asset => {:key => args[0]}})
+        params = {:asset => {:key => args[0]}}
+        params = params.merge(args[1][:params]) if args[1] && args[1][:params]
+        find(:one, :from => "/admin/assets.#{format.extension}", :params => params)
       end
     end
     

data/lib/shopify_api/cli.rb

@@ -0,0 +1,156 @@
+require 'thor'
+
+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?
+          `#{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(file)
+        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
+    
+    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 #{file}"
+    end
+  end
+end

data/shopify_api.gemspec

@@ -2,7 +2,7 @@
 
 Gem::Specification.new do |s|
   s.name = %q{shopify_api}
-  s.version = "1.1.3"
+  s.version = "1.2.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Tobias L\303\274tke", "Cody Fauser", "Dennis Theisen"]
@@ -76,6 +76,7 @@ Copyright (c) 2009 "JadedPixel inc.". See LICENSE for details.
      "README.rdoc",
      "Rakefile",
      "lib/shopify_api.rb",
+     "lib/shopify_api/cli.rb",
      "shopify_api.gemspec",
      "test/order_test.rb",
      "test/shopify_api_test.rb",
@@ -92,18 +93,20 @@ Copyright (c) 2009 "JadedPixel inc.". See LICENSE for details.
      "test/shopify_api_test.rb",
      "test/test_helper.rb"
   ]
+  s.executables = ['shopify']
 
-  if s.respond_to? :specification_version then
+  if s.respond_to? :specification_version
     current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
     s.specification_version = 3
-
-    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
-      s.add_runtime_dependency(%q<activeresource>, [">= 2.2.2"])
-    else
-      s.add_dependency(%q<activeresource>, [">= 2.2.2"])
-    end
+  end
+  
+  s.add_dependency("activeresource", [">= 2.2.2"])
+  s.add_dependency("thor", [">= 0.14.4"])
+  
+  if s.respond_to?(:add_development_dependency)
+    s.add_development_dependency("mocha", ">= 0.9.8")
   else
-    s.add_dependency(%q<activeresource>, [">= 2.2.2"])
+    s.add_dependency("mocha", ">= 0.9.8")
   end
 end
 

data/test/test_helper.rb

@@ -1,5 +1,6 @@
 require 'rubygems'
 require 'test/unit'
+require 'mocha'
 
 $LOAD_PATH.unshift(File.dirname(__FILE__))
 $LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: shopify_api
 version: !ruby/object:Gem::Version 
-  hash: 21
+  hash: 31
   prerelease: false
   segments: 
   - 1
-  - 1
-  - 3
-  version: 1.1.3
+  - 2
+  - 0
+  version: 1.2.0
 platform: ruby
 authors: 
 - "Tobias L\xC3\xBCtke"
@@ -36,6 +36,38 @@ dependencies:
         version: 2.2.2
   type: :runtime
   version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: thor
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 47
+        segments: 
+        - 0
+        - 14
+        - 4
+        version: 0.14.4
+  type: :runtime
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: mocha
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 43
+        segments: 
+        - 0
+        - 9
+        - 8
+        version: 0.9.8
+  type: :development
+  version_requirements: *id003
 description: "= Shopify API\n\n\
   The Shopify API gem allows Ruby developers to programmatically access the admin section of Shopify stores.\n\n\
   The API is implemented as XML over HTTP using all four verbs (GET/POST/PUT/DELETE). Each resource, like Order, Product, or Collection, has its own URL and is manipulated in isolation. In other words, we\xE2\x80\x99ve tried to make the API follow the REST principles as much as possible.\n\n\n\
@@ -57,8 +89,8 @@ description: "= Shopify API\n\n\
   == Copyright\n\n\
   Copyright (c) 2009 \"JadedPixel inc.\". See LICENSE for details.\n"
 email: developers@jadedpixel.com
-executables: []
-
+executables: 
+- shopify
 extensions: []
 
 extra_rdoc_files: 
@@ -72,10 +104,12 @@ files:
 - README.rdoc
 - Rakefile
 - lib/shopify_api.rb
+- lib/shopify_api/cli.rb
 - shopify_api.gemspec
 - test/order_test.rb
 - test/shopify_api_test.rb
 - test/test_helper.rb
+- bin/shopify
 has_rdoc: true
 homepage: http://github.com/Shopify/shopify_api
 licenses: []