Skip to content

Instantly share code, notes, and snippets.

@resistorsoftware
Created May 15, 2011 18:55
Show Gist options
  • Star 0 You must be signed in to star a gist
  • Fork 1 You must be signed in to fork a gist
  • Save resistorsoftware/973428 to your computer and use it in GitHub Desktop.
Save resistorsoftware/973428 to your computer and use it in GitHub Desktop.
A simple way to take advantage of the Shopify API gem CLI
#!/usr/bin/env ruby
require 'rubygems'
require 'shopify_api'
require 'thor'
require 'abbrev'
require 'yaml'
module ShopifyAPI
class Cli < Thor
include Thor::Actions
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|
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'].empty?
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
ShopifyAPI::Cli.start
end
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment