communist 0.1.0

data/.gitignore

@@ -0,0 +1,18 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+*.swp

data/.rvmrc

@@ -0,0 +1,34 @@
+#!/usr/bin/env bash
+
+environment_id="ruby-1.9.3@communist"
+
+#
+# First we attempt to load the desired environment directly from the environment
+# file. This is very fast and efficient compared to running through the entire
+# CLI and selector. If you want feedback on which environment was used then
+# insert the word 'use' after --create as this triggers verbose mode.
+#
+if [[ -d "${rvm_path:-$HOME/.rvm}/environments" \
+  && -s "${rvm_path:-$HOME/.rvm}/environments/$environment_id" ]]
+then
+  \. "${rvm_path:-$HOME/.rvm}/environments/$environment_id"
+
+  if [[ -s "${rvm_path:-$HOME/.rvm}/hooks/after_use" ]]
+  then
+    . "${rvm_path:-$HOME/.rvm}/hooks/after_use"
+  fi
+else
+  # If the environment file has not yet been created, use the RVM CLI to select.
+  if ! rvm --create  "$environment_id"
+  then
+    echo "Failed to create RVM environment '${environment_id}'."
+    return 1
+  fi
+fi
+
+if [[ $- == *i* ]] # check for interactive shells
+then
+    echo "Using: $(tput setaf 2)$GEM_HOME$(tput sgr0)" # show the user the ruby and gemset they are using in green
+else 
+	echo "Using: $GEM_HOME" # don't use colors in interactive shells
+fi

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in communist.gemspec
+gemspec

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2012 Piotr Murach
+
+MIT License
+
+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/README.md

@@ -0,0 +1,62 @@
+# Communist
+
+The Manifesto:
+
+>It is Communist prime role to serve community by providing Cucumber steps for
+>testing external API calls from command line applications. To meet this aim
+>the Communist employees Sinatra DSL for mocking server responses.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'communist'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install communist
+
+## Usage
+
+To get started include the following in your cucumber environment file:
+
+```ruby
+# features/support/env.rb
+require 'communist/cucumber'
+```
+
+The gem uses `ENV['TEST_HOST']` variable to instrument requests. In your command line application add the following logic to switch between live and test requests:
+
+```ruby
+if ENV['TEST_HOST']
+  @@api.endpoint = 'http://' + ENV['TEST_HOST']
+end
+```
+
+Finally, communist has few cucumber steps such as `Given ... server:` that help setting expectations such as:
+
+```ruby
+Scenario: Get blob
+  Given the GitHub API server:
+  """
+  get('/repos/wycats/thor/git/blobs/59b23de9b91d') { status 200 }
+  """
+  When I run `ghub blob get wycats thor 59b23de9b91d`
+  Then the exit status should be 0
+```
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Added some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request
+
+## Copyright
+
+Copyright (c) 2012 Piotr Murach. See LICENSE for further details.

data/Rakefile

@@ -0,0 +1,9 @@
+#!/usr/bin/env rake
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec) do |spec|
+  spec.pattern = FileList['spec/**/*_spec.rb']
+end
+
+task :default => [:spec]

data/communist.gemspec

@@ -0,0 +1,23 @@
+# -*- encoding: utf-8 -*-
+require File.expand_path('../lib/communist/version', __FILE__)
+
+Gem::Specification.new do |gem|
+  gem.authors       = ["Piotr Murach"]
+  gem.email         = [""]
+  gem.description   = %q{Library for mocking CLI calls to external APIs}
+  gem.summary       = %q{Library for mocking CLI calls to external APIs}
+  gem.homepage      = ""
+
+  gem.files         = `git ls-files`.split($\)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.name          = "communist"
+  gem.require_paths = ["lib"]
+  gem.version       = Communist::VERSION
+
+  gem.add_dependency 'rack'
+  gem.add_dependency 'sinatra'
+
+  gem.add_development_dependency 'rspec'
+  gem.add_development_dependency 'rake'
+end

data/lib/communist/cucumber.rb

@@ -0,0 +1,17 @@
+require 'communist/server'
+
+Before do
+  ENV['TEST_HOST'] = '127.0.0.1:0'
+end
+
+After do
+  @server.stop if defined? @server and @server
+end
+
+Given /^the (.*) server:$/ do |name, endpoints|
+  @server = ::Communist::Server.run do
+    eval endpoints, binding
+  end
+
+  ENV['TEST_HOST'] = "127.0.0.1:#{@server.port}"
+end

data/lib/communist/server.rb

@@ -0,0 +1,112 @@
+require 'socket'
+require 'thread'
+require 'sinatra/base'
+require 'net/http'
+require 'communist'
+
+module Communist
+  class Server
+
+    class ServerError < StandardError; end
+
+    class Identify
+      def initialize(app)
+        @app = app
+      end
+
+      def call(env)
+        if env["PATH_INFO"] == "/__identify__"
+          [200, {}, [@app.object_id.to_s]]
+        else
+          @app.call(env)
+        end
+      end
+    end
+
+    class << self
+      def ports
+        @ports ||= {}
+      end
+    end
+
+    attr_reader :app, :port, :host
+
+    def initialize(app, options={})
+      @app  = app
+      @host = options[:host]
+      @server_thread = nil
+    end
+
+    def host
+      "127.0.0.1"
+    end
+
+    def responsive?
+      return false if @server_thread && @server_thread.join(0)
+
+      res = Net::HTTP.start(host, @port) { |http| http.get('/__identify__') }
+
+      if res.is_a?(Net::HTTPSuccess) or res.is_a?(Net::HTTPRedirection)
+        return res.body == @app.object_id.to_s
+      end
+    rescue Errno::ECONNREFUSED, Errno::EBADF
+      return false
+    end
+
+    def start(&block)
+      if @app
+        @port = Server.ports[@app.object_id]
+
+        if not @port or not responsive?
+          @port = find_available_port
+          Server.ports[@pp.object_id] = @port
+
+          @server_thread = Thread.new do
+            Communist.run_default_server(Identify.new(app), @port) do |server|
+              Communist.server = server
+            end
+          end
+
+          Timeout.timeout(5) { @server_thread.join(0.1) until responsive? }
+        end
+      end
+    rescue TimeoutError
+      raise ServerError, "Rack application timed out during start"
+    else
+      self
+    end
+
+    def stop
+      Communist.server.respond_to?(:stop!) ? Communist.server.stop! : Communist.server.stop
+      @server_thread.join
+    end
+
+    def self.run(&block)
+      app = Sinatra.new do
+        set :environment, :test
+        disable :protection
+
+        self.class_eval(&block)
+
+        helpers do
+          def body(value=nil)
+            super
+            nil
+          end
+        end
+      end
+
+      new(app).start
+    end
+
+  private
+
+    def find_available_port
+      server = TCPServer.new('127.0.0.1', 0)
+      server.addr[Socket::Constants::SOCK_STREAM]
+    ensure
+      server.close if server
+    end
+
+  end # Server
+end # Communist

data/lib/communist/version.rb

@@ -0,0 +1,3 @@
+module Communist
+  VERSION = "0.1.0"
+end

data/lib/communist.rb

@@ -0,0 +1,49 @@
+require 'communist/version'
+require 'rack'
+
+module Communist
+  class << self
+    attr_accessor :app_host
+    attr_accessor :default_host
+    attr_accessor :run_server
+    attr_accessor :app
+
+    # Possible options
+    #
+    def configure
+      yield self
+    end
+
+    def server=(instance)
+      @server = instance
+    end
+
+    def server(&block)
+      if block_given?
+        @server = block
+      else
+        @server
+      end
+    end
+
+    # By default run thin or fall back on webrick
+    #
+    def run_default_server(app, port, &block)
+      begin
+        require 'rack/handler/thin'
+        Thin::Logging.silent = true
+        Rack::Handler::Thin.run(app, :Port => port, &block)
+      rescue LoadError
+        require 'rack/handler/webrick'
+        Rack::Handler::WEBrick.run(app, :Port => port, :AccessLog => [], :Logger => WEBrick::Log::new(nil, 0), &block)
+      end
+    end
+
+  end
+
+  autoload :Server,   'communist/server'
+
+end # Communist
+
+Communist.configure do |config|
+end

data/spec/spec_helper.rb

@@ -0,0 +1,10 @@
+require 'rubygems'
+
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+
+require 'rspec'
+
+RSpec.configure do |config|
+  config.order = :rand
+end

metadata

@@ -0,0 +1,102 @@
+--- !ruby/object:Gem::Specification
+name: communist
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+  prerelease: 
+platform: ruby
+authors:
+- Piotr Murach
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-07-14 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rack
+  requirement: &2152389780 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *2152389780
+- !ruby/object:Gem::Dependency
+  name: sinatra
+  requirement: &2152389340 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *2152389340
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: &2152388880 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *2152388880
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: &2152388400 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *2152388400
+description: Library for mocking CLI calls to external APIs
+email:
+- ''
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rvmrc
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- communist.gemspec
+- lib/communist.rb
+- lib/communist/cucumber.rb
+- lib/communist/server.rb
+- lib/communist/version.rb
+- spec/spec_helper.rb
+homepage: ''
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.10
+signing_key: 
+specification_version: 3
+summary: Library for mocking CLI calls to external APIs
+test_files:
+- spec/spec_helper.rb