gemical 0.0.2

data/README.md

@@ -0,0 +1,28 @@
+# Gemical command-line client
+
+Manage your private Gems in through the command line.
+
+## License
+
+(The MIT License)
+
+Copyright (c) 2011 Black Square Media Ltd
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
+IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
+CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
+TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
+SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/bin/gemical

@@ -0,0 +1,6 @@
+#!/usr/bin/env ruby
+
+lib = File.expand_path('../../lib', __FILE__)
+$LOAD_PATH.unshift(lib) if File.directory?(lib) && !$LOAD_PATH.include?(lib)
+
+require 'gemical/import'

data/lib/gemical/auth.rb

@@ -0,0 +1,113 @@
+class Gemical::Auth
+  include Gemical::Singleton
+
+  def configuration
+    Gemical.configuration
+  end
+
+  def verify_account!
+    @verified_account ||= if credentials
+      get_account
+    else
+      say_ok "\nWelcome to Gemical! You are new, right?"
+      say_ok "We need to authenticate your account:"
+      collect_credentials
+    end
+  end
+
+  def verify_vault!
+    verify_account!
+
+    @verified_vault ||= if primary_vault
+      get_vault(primary_vault) || collect_vault("Ooops, you don't seem to have access to '#{primary_vault}' anymore.")
+    else
+      collect_vault("You haven't specified your primary vault yet.")
+    end
+  end
+
+  def vaults
+    verify_account!
+    @vaults ||= Gemical.connection.get("/vaults").map do |hash|
+      Gemical::Vault.new(hash)
+    end
+  end
+
+  def credentials
+    return nil unless configuration.credentials?
+    pair = configuration.credentials.read.split(/\s+/)[0..1]
+    pair if pair.size == 2 && pair.all? {|v| string_value?(v) }
+  end
+
+  def basic_auth
+    [credentials.last, 'x'] if credentials
+  end
+
+  def primary_vault
+    return nil unless configuration.primary_vault?
+    value = configuration.primary_vault.read.split(/\s+/).first
+    value if string_value?(value)
+  end
+
+  private
+
+    def get_account
+      Gemical.connection.get("/account")
+    rescue Gemical::Connection::HTTPUnauthorized
+      renew_credentials?
+    end
+
+    def collect_credentials(attempt = 1)
+      email   = ask('Email:    ')
+      pass    = password
+      account = Gemical.connection.get "/account", :basic_auth => [email, pass]
+      configuration.write! :credentials, email, account["authentication_token"]
+      say_ok "Authentication successful. Thanks!\n"
+      account
+    rescue Gemical::Connection::HTTPUnauthorized
+      if attempt < 3
+        say_warning "\nInvalid email and/or password."
+        say_warning "Try again:"
+        attempt += 1
+        retry
+      else
+        say_error "\nAre your sure you have the right credentials?"
+        say_error "Visit http://gemical.com/password/new for instructions."
+        exit(1)
+      end
+    end
+
+    def renew_credentials?
+      say_warning "\nYour stored credentials seem to be outdated."
+      if agree("Do you want to re-authenticate your account? ")
+        collect_credentials
+      else
+        say_warning "You can check your stored credentials in #{configuration.credentials}."
+        exit(1)
+      end
+    end
+
+    def get_vault(name)
+      ensure_vaults!
+      vaults.find {|v| v == name }
+    end
+
+    def collect_vault(message, save = true)
+      ensure_vaults!
+      say_warning "\n#{message}"
+      name = ask "Which one should it be: ", vaults
+      configuration.write! :primary_vault, name
+      get_vault(name)
+    end
+
+    def ensure_vaults!
+      return unless vaults.empty?
+      say_error "You have no vaults associated with your account."
+      say_error "Please sign in to your account and create one: http://gemical.com/sign_in."
+      exit(1)
+    end
+
+    def string_value?(value)
+      value.is_a?(String) && !value.strip.empty?
+    end
+
+end

data/lib/gemical/commands/base.rb

@@ -0,0 +1,44 @@
+class Gemical::Commands::Base
+
+  protected
+
+    def current_path
+      @current_path ||= Pathname.new(File.expand_path('.'))
+    end
+
+    def terminate(message)
+      say_error message
+      exit(1)
+    end
+
+    def success(message)
+      say_ok message
+      exit(0)
+    end
+
+    def full_errors(errors, mappings = {})
+      errors.map do |attr, messages|
+        name = mappings[attr] || attr
+        messages.map do |message|
+          "#{name} #{message}"
+        end.join(', ')
+      end.join(', ')
+    end
+
+    def authenticate!
+      Gemical.auth.verify_account!
+    end
+
+    def conn
+      Gemical.connection
+    end
+
+    def current_vault(options)
+      options.vault || primary_vault
+    end
+
+    def primary_vault
+      Gemical.auth.verify_vault!
+    end
+
+end

data/lib/gemical/commands/bundle.rb

@@ -0,0 +1,49 @@
+class Gemical::Commands::Bundle < Gemical::Commands::Base
+
+  class Evaluator
+    attr_reader :sources
+
+    def initialize(file)
+      @sources = []
+      instance_eval file.read
+    end
+
+    def source(path, *)
+      @sources << path
+    end
+
+    def method_missing(sym, *a)
+    end
+  end
+
+  def create(args, options)
+    gemfile = current_path.join('Gemfile')
+    terminate "Unable to find a Gemfile in #{current_path}" unless gemfile.file?
+    terminate "Gemfile in #{current_path} is not writable" unless gemfile.writable?
+
+    evaluation = Evaluator.new(gemfile)
+    terminate "Gemfile doesn't seem to be valid" if evaluation.sources.empty?
+
+    authenticate!
+    vault = current_vault(options)
+
+    if evaluation.sources.any? {|s| s.to_s.include?(vault.token) }
+      terminate "Vault '#{vault}' is already sourced in your Gemfile."
+    end
+
+    source = gemfile.open('r')
+    output = Tempfile.new "Gemfile"
+
+    while string = source.gets
+      output << string
+      if string =~ /^(\s*)source\b/
+        output << "#{$1}source 'http://#{vault.token}@bundle.gemical.com'\n"
+      end
+    end
+    output.close
+
+    FileUtils.cp output.path, source.path
+    success "Vault '#{vault}' was added as a source to your Gemfile."
+  end
+
+end

data/lib/gemical/commands/gems.rb

@@ -0,0 +1,46 @@
+class Gemical::Commands::Gems < Gemical::Commands::Base
+
+  def index(args, options)
+    authenticate!
+
+    vault = current_vault(options)
+    conn.get("/vaults/#{vault}/gems").each do |rubygem|
+      versions = rubygem["versions"].map {|v| v["name"] }.sort.reverse
+      say "#{rubygem["name"]} (#{versions.join(', ')})"
+    end
+  rescue Gemical::Connection::HTTPNotFound
+    terminate "Sorry, no such vault '#{vault}'."
+  end
+
+  def create(args, options)
+    terminate "Please provide a GEM file." unless args.first.is_a?(String)
+
+    file = current_path.join(args.first)
+    terminate "Hmm, no file in #{file}" unless file.file?
+
+    authenticate!
+    vault    = current_vault(options)
+    response = conn.post("/vaults/#{vault}/gems", :params => { "rubygem[file]" => file.open('rb') })
+    success "#{response['original_name']} was successfully added to vault '#{vault}'."
+  rescue Gemical::Connection::HTTPNotFound
+    terminate "Sorry, no such vault '#{vault}'."
+  rescue Gemical::Connection::HTTPUnprocessable => e
+    terminate "Sorry, #{full_errors(e.response, 'name' => 'gem')}"
+  end
+
+  def destroy(args, options)
+    name, version = args.first(2)
+    terminate "Please provide a valid GEM name." unless name.to_s =~ /\A[\w\-]+\z/
+    terminate "Please provide a valid VERSION." unless version.to_s =~ /\A[\w\-\.]+\z/
+
+    authenticate!
+    vault    = current_vault(options)
+    response = conn.delete("/vaults/#{vault}/gems/#{name}/#{version}")
+    success "#{name} (#{version}) was successfully removed from #{vault}."
+  rescue Gemical::Connection::HTTPNotFound
+    terminate "Sorry, unable to find '#{name} (#{version})' in vault '#{vault}'."
+  rescue Gemical::Connection::HTTPUnprocessable => e
+    "Sorry, #{full_errors(e.response)}"
+  end
+
+end

data/lib/gemical/commands/vaults.rb

@@ -0,0 +1,11 @@
+class Gemical::Commands::Vaults < Gemical::Commands::Base
+
+  def index(args, options)
+    authenticate!
+
+    Gemical.auth.vaults.each do |vault|
+      say vault
+    end
+  end
+
+end

data/lib/gemical/commands.rb

@@ -0,0 +1,6 @@
+module Gemical::Commands
+  autoload :Base, 'gemical/commands/base'
+  autoload :Bundle, 'gemical/commands/bundle'
+  autoload :Gems, 'gemical/commands/gems'
+  autoload :Vaults, 'gemical/commands/vaults'
+end

data/lib/gemical/configuration.rb

@@ -0,0 +1,55 @@
+require 'fileutils'
+
+class Gemical::Configuration
+  include Gemical::Singleton
+
+  attr_writer :home
+
+  def initialize
+    @home = ENV['HOME']
+  end
+
+  def root
+    @root ||= Pathname.new File.join(@home, ".gemical")
+  end
+
+  def credentials
+    root.join('credentials')
+  end
+
+  def primary_vault
+    root.join('primary_vault')
+  end
+
+  def root?
+    root.directory? && root.readable?
+  end
+
+  def credentials?
+    readable_file? credentials
+  end
+
+  def primary_vault?
+    readable_file? primary_vault
+  end
+
+  def create_root!
+    return if root?
+    FileUtils.mkdir_p root
+    FileUtils.chmod_R 0700, root
+  end
+
+  def write!(symbol, *lines)
+    create_root!
+    send(symbol).open "w", 0600 do |file|
+      file << (lines + ['']).join("\n")
+    end
+  end
+
+  private
+
+    def readable_file?(path)
+      root? && path.file? && path.readable?
+    end
+
+end

data/lib/gemical/connection.rb

@@ -0,0 +1,78 @@
+require 'restclient'
+require 'multi_json'
+
+class Gemical::Connection
+  include Gemical::Singleton
+
+  HTTPError        = Class.new(StandardError)
+  HTTPUnauthorized = Class.new(HTTPError)
+  HTTPServerError  = Class.new(HTTPError)
+  HTTPNotFound     = Class.new(HTTPError)
+
+  class HTTPUnprocessable < HTTPError
+
+    attr_reader :response
+
+    def initialize(response)
+      @response = response
+      super "Unprocessable Entity (422)"
+    end
+
+  end
+
+  attr_accessor :base_url
+
+  def initialize
+    @base_url  = ENV['GEMICAL_URL'] || "http://api.gemical.com"
+    self.proxy = ENV['http_proxy']
+  end
+
+  def proxy
+    RestClient.proxy
+  end
+
+  def proxy=(url)
+    RestClient.proxy = url if url
+  end
+
+  def get(path, options = {})
+    request :get, path, build_headers(options)
+  end
+
+  def post(path, options = {})
+    request :post, path, options.delete(:params), build_headers(options)
+  end
+
+  def delete(path, options = {})
+    request :delete, path, build_headers(options)
+  end
+
+  protected
+
+    def request(method, path, *args)
+      url = [base_url, path].join
+      MultiJson.decode RestClient.send(method, url, *args)
+    rescue SocketError, Errno::ECONNREFUSED, Errno::ETIMEDOUT
+      say_error "Ooops. Can't establish a connection to #{base_url}. Are you on-line?"
+      exit(1)
+    rescue RestClient::UnprocessableEntity => e
+      raise HTTPUnprocessable.new MultiJson.decode(e.response.body)
+    rescue RestClient::Unauthorized, RestClient::Forbidden => e
+      raise HTTPUnauthorized, "Unauthorized request (#{e.http_code})"
+    rescue RestClient::ResourceNotFound
+      raise HTTPNotFound, "Resource not found (404)"
+    rescue RestClient::Exception => e
+      raise HTTPServerError, "Service responded with #{e.to_s}"
+    end
+
+    def build_headers(options)
+      { :accept => :json }.merge(authorization(options)).merge(options.delete(:headers) || {})
+    end
+
+    def authorization(options)
+      pair  = options.delete(:basic_auth) || Gemical.auth.basic_auth
+      token = [pair.join(':')].pack("m").delete("\r\n")
+      { :authorization => "Basic #{token}" }
+    end
+
+end

data/lib/gemical/format/command_help.erb

@@ -0,0 +1,25 @@
+
+  Usage:
+    <%= @syntax || "gemical #{@name} [options]" %>
+<% if @description || @summary -%>
+
+  Summary:
+    <%= @description || @summary %>
+<% end -%>
+<% unless @options.empty? -%>
+
+  Options:
+<% for option in @options -%>
+    <%= "%-20s %s" % [option[:switches].join(', '), option[:description]] %>
+<% end -%>
+<% end -%>
+<% unless @examples.empty? -%>
+
+  Examples:
+  <% for description, command in @examples -%>
+
+    # <%= description %>
+    <%= command %>
+  <% end -%>
+<% end -%>
+

data/lib/gemical/format/help.erb

@@ -0,0 +1,28 @@
+
+  <%= program :name %>
+
+  Commands:
+<% for name, command in @commands.sort -%>
+<% unless alias? name -%>
+    <%= "%-20s %s" % [command.name, command.summary || command.description] %>
+<% end -%>
+<% end -%>
+<% unless @aliases.empty? %>
+  Aliases:
+<% for alias_name, args in @aliases.sort -%>
+    <%= "%-20s %s %s" % [alias_name, command(alias_name).name, args.join(' ')] %>
+<% end -%>
+<% end %>
+<% unless @options.empty? -%>
+  Global Options:
+<% for option in @options -%>
+    <%= "%-20s %s" % [option[:switches].join(', '), option[:description]] %>
+<% end -%>
+<% end -%>
+<% if program :help -%>
+  <% for title, body in program(:help) %>
+  <%= title %>:
+    <%= body %>
+  <% end %>
+<% end -%>
+

data/lib/gemical/format.rb

@@ -0,0 +1,8 @@
+class Gemical::Format < Commander::HelpFormatter::Terminal
+
+  def template name
+    path = File.expand_path("../format/#{name}.erb", __FILE__)
+    ERB.new File.read(path), nil, '-'
+  end
+
+end

data/lib/gemical/import.rb

@@ -0,0 +1,51 @@
+require 'gemical'
+require 'commander/import'
+
+program :version, Gemical::VERSION::STRING
+program :name, 'Gemical command-line client ~ http://gemical.com'
+program :description, '-'
+program :help_formatter, Gemical::Format
+
+command :bundle do |c|
+  c.summary = 'Bundle a vault with your project'
+  c.description = 'This command will add one of your vaults as a source to the Gemfile'
+  c.example 'Bundle your primary vault', 'cd my-project; gemical bundle'
+  c.example 'Bundle a specific vault', 'cd my-project; gemical bundle --vault my-vault'
+  c.option '--vault VAULT', 'Specify a vault'
+  c.when_called Gemical::Commands::Bundle, :create
+end
+
+command :vaults do |c|
+  c.syntax = 'gemical vaults'
+  c.summary = 'List all vaults'
+  c.description = 'This command will list all vaults you have access to'
+  c.description = 'Display all my vaults'
+  c.when_called Gemical::Commands::Vaults, :index
+end
+
+command :gems do |c|
+  c.summary = 'List all gems within a vault'
+  c.description = 'This command will list all Gems within a vault (primary, unless specified)'
+  c.option '--vault [VAULT]', 'Specify a vault'
+  c.when_called Gemical::Commands::Gems, :index
+end
+
+command :"gems:add" do |c|
+  c.syntax = 'gemical gems:add GEM [options]'
+  c.summary = 'Add a gem to a vault'
+  c.description = 'This command will upload the specified Gem to one of your vaults (primary, unless specified)'
+  c.example 'Push a Gem to your primary vault', 'gemical gems:add my-gem-1.0.0.gem'
+  c.example 'Push a Gem to a specific vault', 'gemical gems:add my-gem-1.0.0.gem --vault my-vault'
+  c.option '--vault VAULT', 'Specify a vault'
+  c.when_called Gemical::Commands::Gems, :create
+end
+
+command :"gems:remove" do |c|
+  c.syntax = 'gemical gems:remove GEM VERSION [options]'
+  c.summary = 'Remove gem from a vault'
+  c.description = 'This command will remove the specified Gem version from one of your vaults (primary, unless specified)'
+  c.example 'Remove a Gem from your primary vault', 'gemical gems:remove my-gem 1.0.0'
+  c.example 'Remove a Gem from a specific vault', 'gemical gems:remove my-gem 1.0.0 --vault my-vault'
+  c.option '--vault VAULT', 'Specify a vault'
+  c.when_called Gemical::Commands::Gems, :destroy
+end

data/lib/gemical/singleton.rb

@@ -0,0 +1,22 @@
+module Gemical::Singleton
+
+  def self.included(base)
+    class << base
+      private :new
+    end
+    base.extend ClassMethods
+  end
+
+  module ClassMethods
+
+    def instance
+      @instance ||= new
+    end
+
+    def reload!
+      @instance = nil
+    end
+
+  end
+
+end

data/lib/gemical/vault.rb

@@ -0,0 +1,10 @@
+class Gemical::Vault < String
+
+  attr_reader :token
+
+  def initialize(hash)
+    @token = hash["token"]
+    super hash["name"]
+  end
+
+end

data/lib/gemical/version.rb

@@ -0,0 +1,10 @@
+module Gemical
+  module VERSION #:nodoc:
+    MAJOR = 0
+    MINOR = 0
+    TINY  = 2
+    PRE   = nil
+
+    STRING = [MAJOR, MINOR, TINY, PRE].compact.join('.')
+  end
+end

data/lib/gemical.rb

@@ -0,0 +1,31 @@
+require 'rubygems'
+require 'pathname'
+require 'erb'
+require 'commander'
+
+include Commander::UI
+include Commander::UI::AskForClass
+
+module Gemical
+  autoload :Auth, 'gemical/auth'
+  autoload :Format, 'gemical/format'
+  autoload :Commands, 'gemical/commands'
+  autoload :Configuration, 'gemical/configuration'
+  autoload :Connection, 'gemical/connection'
+  autoload :Singleton, 'gemical/singleton'
+  autoload :Vault, 'gemical/vault'
+  autoload :VERSION, 'gemical/version'
+
+  def self.auth
+    Gemical::Auth.instance
+  end
+
+  def self.configuration
+    Gemical::Configuration.instance
+  end
+
+  def self.connection
+    Gemical::Connection.instance
+  end
+
+end

metadata

@@ -0,0 +1,129 @@
+--- !ruby/object:Gem::Specification
+name: gemical
+version: !ruby/object:Gem::Version
+  version: 0.0.2
+  prerelease: 
+platform: ruby
+authors:
+- Black Square Media Ltd
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2011-11-12 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: commander
+  requirement: &14809440 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *14809440
+- !ruby/object:Gem::Dependency
+  name: rest-client
+  requirement: &14808980 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *14808980
+- !ruby/object:Gem::Dependency
+  name: multi_json
+  requirement: &14808520 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *14808520
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: &14808080 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *14808080
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: &14807560 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *14807560
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: &14807060 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *14807060
+description: Manage your private Gems through the command line.
+email: info@blacksquaremedia.com
+executables:
+- gemical
+extensions: []
+extra_rdoc_files: []
+files:
+- README.md
+- lib/gemical.rb
+- lib/gemical/connection.rb
+- lib/gemical/singleton.rb
+- lib/gemical/format/help.erb
+- lib/gemical/format/command_help.erb
+- lib/gemical/auth.rb
+- lib/gemical/configuration.rb
+- lib/gemical/commands.rb
+- lib/gemical/import.rb
+- lib/gemical/vault.rb
+- lib/gemical/version.rb
+- lib/gemical/format.rb
+- lib/gemical/commands/base.rb
+- lib/gemical/commands/bundle.rb
+- lib/gemical/commands/vaults.rb
+- lib/gemical/commands/gems.rb
+- bin/gemical
+homepage: http://github.com/bsm/gemical
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: 1.8.7
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: 1.3.6
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.10
+signing_key: 
+specification_version: 3
+summary: Gemical command-line client.
+test_files: []