fakeapi 0.0.1 → 0.0.2

data/.gitignore

@@ -15,3 +15,5 @@ spec/reports
 test/tmp
 test/version_tmp
 tmp
+.env
+vcr/*.yml

data/.rspec

@@ -0,0 +1 @@
+--color

data/README.md

@@ -1,12 +1,14 @@
-# Fakeapi
+# FakeAPI
 
-TODO: Write a gem description
+FakeAPI = Sinatra + VCR
 
 ## Installation
 
 Add this line to your application's Gemfile:
 
-    gem 'fakeapi'
+```ruby
+gem 'fakeapi'
+```
 
 And then execute:
 
@@ -18,7 +20,100 @@ Or install it yourself as:
 
 ## Usage
 
-TODO: Write usage instructions here
+Let's say you're building FakeBitly service.
+
+0. (Optional) Due to incompatibility between webmock and artifice you
+   have to use newer versions of webmock:
+
+```ruby
+# Gemfile
+source :rubygems
+
+gem 'fakeapi', path: '~/Code/vendor/fakeapi'
+gem 'webmock', github: 'bblimke/webmock', ref: '2c596f'
+gem 'rspec'
+gem 'bitly'
+```
+
+1. Create fake service:
+
+```ruby
+# fake_bitly.rb
+require 'fakeapi'
+
+class FakeBitly < FakeAPI::App
+end
+```
+
+2. Create a spec. You don't want to test FakeBitly endpoints directly.
+   Instead use a client library. `FakeBitly.test` (inherited from
+   `FakeAPI::App`) will try to use your fake service (using `Artifice`)
+   and if that fails it will record the HTTP interaction (using `VCR`).
+
+```ruby
+# fake_bitly_spec.rb
+require_relative './fake_bitly'
+require 'bitly'
+
+describe FakeBitly do
+  before do
+    Bitly.use_api_version_3
+    @bitly = Bitly.new(ENV.fetch('BITLY_USERNAME'), ENV.fetch('BITLY_APIKEY'))
+  end
+
+  it 'handles /v3/shorten' do
+    hash = FakeBitly.test('shorten') { @bitly.shorten('http://google.com').user_hash }
+    hash.should have(6).characters
+  end
+end
+```
+
+3. Run the spec:
+
+```bash
+% bundle exec rspec fake_bitly_spec.rb
+#<BitlyError:  - ''>
+
+Use generated code:
+
+  get '/v3/shorten' do
+    status 200
+    content_type 'application/json; charset=utf-8'
+    body JSON(status_code: 200, status_txt: "OK", data: {long_url: "http://google.com/", url: "http://bit.ly/ORN1fW", hash: "ORN1fW", global_hash: "LmvF", new_hash: 0})
+  end
+
+F
+
+Failures:
+
+  1) FakeBitly handles /v3/shorten
+     Failure/Error: hash = FakeBitly.test('shorten') { @bitly.shorten('http://google.com').user_hash }
+     NotImplementedError:
+       NotImplementedError
+```
+
+4. Use generated code:
+
+```ruby
+# fake_bitly.rb
+class FakeBitly < FakeAPI::App
+  get '/v3/shorten' do
+    status 200
+    content_type 'application/json; charset=utf-8'
+    body JSON(status_code: 200, status_txt: "OK", data: {long_url: "http://google.com/", url: "http://bit.ly/ORN1fW", hash: "ORN1fW", global_hash: "LmvF", new_hash: 0})
+  end
+end
+```
+
+5. Run specs:
+
+```bash
+% bundle exec rspec fake_bitly_spec.rb
+.
+
+Finished in 0.0497 seconds
+1 example, 0 failures
+```
 
 ## Contributing
 
@@ -27,3 +122,26 @@ TODO: Write usage instructions here
 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
+
+## License
+
+Copyright (c) 2013 Wojciech Mach
+
+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/Rakefile

@@ -1,2 +1,12 @@
 #!/usr/bin/env rake
 require "bundler/gem_tasks"
+
+task :test do
+  system 'rspec spec/'
+end
+
+task :examples do
+  system "sh -c 'cd examples/fake_bitly ; bundle exec rspec spec/ ; cd ../..'"
+end
+
+task :default => :test

data/examples/fake_bitly/.gitignore

@@ -0,0 +1 @@
+/script

data/examples/fake_bitly/.rspec

@@ -0,0 +1 @@
+--color

data/examples/fake_bitly/Gemfile

@@ -0,0 +1,12 @@
+source :rubygems
+
+gem 'rake'
+gem 'dotenv'
+gem 'webmock', github: 'bblimke/webmock'
+gem 'bitly'
+gem 'rack-test'
+gem 'vcr'
+gem 'sinatra'
+gem 'artifice'
+gem 'rspec'
+gem 'term-ansicolor'

data/examples/fake_bitly/Rakefile

@@ -0,0 +1,5 @@
+task :test do
+  system 'rspec spec'
+end
+
+task :default => :test

data/examples/fake_bitly/config.ru

@@ -0,0 +1,3 @@
+require './lib/fake_bitly'
+
+run FakeBitly

data/examples/fake_bitly/lib/fake_bitly.rb

@@ -0,0 +1,5 @@
+$:.unshift File.dirname(__FILE__) + '/../../../lib'
+require 'fakeapi'
+
+class FakeBitly < FakeAPI::App
+end

data/examples/fake_bitly/spec/fake_bitly_spec.rb

@@ -0,0 +1,17 @@
+require_relative '../lib/fake_bitly'
+require 'dotenv'
+require 'bitly'
+
+Dotenv.load
+
+describe FakeBitly do
+  before do
+    Bitly.use_api_version_3
+    @bitly = Bitly.new(ENV.fetch('BITLY_USERNAME'), ENV.fetch('BITLY_APIKEY'))
+  end
+
+  it 'handles /v3/shorten' do
+    hash = FakeBitly.test('shorten') { @bitly.shorten('http://google.com').user_hash }
+    hash.should have(6).characters
+  end
+end

data/examples/fake_bitly/vcr/shorten.yml

@@ -0,0 +1,36 @@
+---
+http_interactions:
+- request:
+    method: get
+    uri: http://api.bit.ly/v3/shorten?apiKey=R_09c2f2080b43230744cbac384b7ce0ca&login=wojtekmach&longUrl=http://google.com
+    body:
+      encoding: US-ASCII
+      string: ''
+    headers: {}
+  response:
+    status:
+      code: 200
+      message: OK
+    headers:
+      Server:
+      - nginx
+      Date:
+      - Sun, 27 Jan 2013 09:17:20 GMT
+      Content-Type:
+      - application/json; charset=utf-8
+      Connection:
+      - keep-alive
+      Mime-Version:
+      - '1.0'
+      Content-Length:
+      - '182'
+    body:
+      encoding: US-ASCII
+      string: ! '{ "status_code": 200, "status_txt": "OK", "data": { "long_url": "http:\/\/google.com\/",
+        "url": "http:\/\/bit.ly\/ORN1fW", "hash": "ORN1fW", "global_hash": "LmvF",
+        "new_hash": 0 } }
+
+'
+    http_version: 
+  recorded_at: Sun, 27 Jan 2013 09:17:20 GMT
+recorded_with: VCR 2.4.0

data/fakeapi.gemspec

@@ -14,4 +14,15 @@ Gem::Specification.new do |gem|
   gem.name          = 'fakeapi'
   gem.require_paths = ['lib']
   gem.version       = FakeAPI::VERSION
+
+  gem.add_dependency 'vcr'
+  gem.add_dependency 'webmock'
+  gem.add_dependency 'artifice'
+  gem.add_dependency 'term-ansicolor'
+  gem.add_dependency 'sinatra'
+
+  gem.add_development_dependency 'rake'
+  gem.add_development_dependency 'rspec'
+  gem.add_development_dependency 'dotenv'
+  gem.add_development_dependency 'bitly'
 end

data/lib/fakeapi.rb

@@ -1,4 +1,7 @@
 require 'fakeapi/version'
+require 'fakeapi/app'
+require 'fakeapi/generator'
+require 'fakeapi/test_run'
 
 module FakeAPI
 end

data/lib/fakeapi/app.rb

@@ -0,0 +1,9 @@
+require 'sinatra/base'
+
+module FakeAPI
+  class App < Sinatra::Base
+    def self.test(method_name, &call_block)
+      TestRun.new(self, method_name, call_block).run
+    end
+  end
+end

data/lib/fakeapi/generator.rb

@@ -0,0 +1,59 @@
+require 'yaml'
+require 'json'
+require 'uri'
+
+module FakeAPI
+  class Generator
+    def self.generate(*args)
+      new(*args).generate
+    end
+
+    def initialize(name)
+      @name = name
+    end
+
+    def generate
+      hash = VCRReader.read("vcr/#{@name}.yml")
+
+      http_method = hash['request']['method']
+      url = URI(hash['request']['uri']).path
+      status = hash['response']['status']['code']
+      content_type = hash['response']['headers']['Content-Type'].first
+
+      body = hash['response']['body']['string']
+
+      body = if content_type =~ /json/i
+               write_json(body)
+             else
+               write_text(body)
+             end
+
+      <<RUBY
+  #{http_method} '#{url}' do
+    status #{status}
+    content_type '#{content_type}'
+    body #{body}
+  end
+RUBY
+    end
+
+    def write_json(body)
+      require_relative './json_writer'
+      JSONWriter.write(JSON.parse(body, symbolize_names: true).to_hash)
+    end
+
+    def write_text(body)
+      '"' + body + '"'
+    end
+  end
+
+  class VCRReader
+    def self.read(filename)
+      hash = YAML.load_file(filename)
+      request_hash = hash['http_interactions'][0]['request']
+      response_hash = hash['http_interactions'][0]['response']
+
+      {'request' => request_hash, 'response' => response_hash}
+    end
+  end
+end

data/lib/fakeapi/json_writer.rb

@@ -0,0 +1,25 @@
+require 'json'
+
+class Hash
+  def inspect
+    inner = map do |key, val|
+      key_str = key.is_a?(Symbol) ? "#{key}: " : key.inspect + "=>"
+      key_str + val.inspect
+    end.join(", ")
+    "{#{inner}}"
+  end
+end
+
+module FakeAPI
+  class JSONWriter
+    def self.write(json)
+      inner = json.inspect
+      inner = remove_brackets_for_hash_argument(inner) if json.is_a?(Hash)
+      "JSON(#{inner})"
+    end
+
+    def self.remove_brackets_for_hash_argument(str)
+      str[1..-2]
+    end
+  end
+end

data/lib/fakeapi/test_run.rb

@@ -0,0 +1,57 @@
+require 'vcr'
+require 'artifice'
+require 'term/ansicolor'
+
+VCR.configure do |c|
+  c.cassette_library_dir = 'vcr'
+  c.hook_into :webmock
+end
+
+module FakeAPI
+  class TestRun
+    NET_HTTP = ::Net::HTTP
+
+    def initialize(api, method_name, run_block)
+      @api = api
+      @method_name = method_name
+      @run_block = run_block
+    end
+
+    def run
+      begin
+        run_with_artifice
+      rescue => ex
+        p ex
+        run_with_vcr
+      end
+    end
+
+    def run_with_artifice
+      ret = nil
+      Artifice.activate_with @api do
+        ret = @run_block.call
+      end
+      ret
+    end
+
+    def run_with_vcr
+      if ::Net::HTTP != NET_HTTP
+        ::Net.class_eval do
+          remove_const(:HTTP)
+          const_set(:HTTP, NET_HTTP)
+        end
+      end
+
+      VCR.use_cassette(@method_name, &@run_block)
+
+      color = Term::ANSIColor
+
+      puts
+      puts color.green + 'Use generated code:' + color.clear
+      puts
+      puts color.yellow + FakeAPI::Generator.generate(@method_name) + color.clear
+
+      raise NotImplementedError
+    end
+  end
+end

data/lib/fakeapi/version.rb

@@ -1,3 +1,3 @@
 module FakeAPI
-  VERSION = '0.0.1'
+  VERSION = '0.0.2'
 end

data/spec/fakeapi/generator_spec.rb

@@ -0,0 +1,33 @@
+require 'fakeapi/generator'
+
+describe FakeAPI::Generator do
+  def generate(name)
+    described_class.generate(name)
+  end
+
+  it 'return soruce code for method' do
+    FakeAPI::VCRReader.stub(:read).with('vcr/shorten.yml') do
+      {
+        'request' =>
+          {
+            'uri' => 'http://api.bitly.com/api/v3/shorten?longUrl=foo',
+            'method' => 'get',
+          },
+        'response' =>
+          {
+            'status' => {'code' => 200},
+            'headers' => {'Content-Type' => ['application/json']},
+            'body' => {'string' => '{"message":"hello"}'},
+          }
+      }
+    end
+
+    generate('shorten').should == <<RUBY
+  get '/api/v3/shorten' do
+    status 200
+    content_type 'application/json'
+    body JSON(message: "hello")
+  end
+RUBY
+  end
+end

data/spec/fakeapi/json_writer_spec.rb

@@ -0,0 +1,31 @@
+require 'fakeapi/json_writer'
+
+describe FakeAPI::JSONWriter do
+  def write(json)
+    described_class.write(json)
+  end
+
+  it 'handles strings' do
+    write("hello").should == 'JSON("hello")'
+  end
+
+  it 'handles arrays' do
+    write([1, 2]).should == 'JSON([1, 2])'
+  end
+
+  it 'handles hashes' do
+    write(a: 1, b: 2).should == 'JSON(a: 1, b: 2)'
+  end
+
+  it 'handles hashes with string keys' do
+    write("a" => 1).should == 'JSON("a"=>1)'
+  end
+
+  it 'handles arrays of hashes' do
+    write([{a: 1}]).should == 'JSON([{a: 1}])'
+  end
+
+  it 'handles nested arrays' do
+    write(a: {b: 1}).should == 'JSON(a: {b: 1})'
+  end
+end

data/spec/fakeapi/test_run_spec.rb

@@ -0,0 +1,4 @@
+require 'fakeapi/test_run'
+
+describe FakeAPI::TestRun do
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: fakeapi
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
   prerelease: 
 platform: ruby
 authors:
@@ -9,8 +9,152 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-08-04 00:00:00.000000000 Z
-dependencies: []
+date: 2013-01-27 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: vcr
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: artifice
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: term-ansicolor
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: sinatra
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: dotenv
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bitly
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 description: FakeAPI o
 email:
 - wojtek@wojtekmach.pl
@@ -19,13 +163,29 @@ extensions: []
 extra_rdoc_files: []
 files:
 - .gitignore
+- .rspec
 - Gemfile
 - LICENSE
 - README.md
 - Rakefile
+- examples/fake_bitly/.gitignore
+- examples/fake_bitly/.rspec
+- examples/fake_bitly/Gemfile
+- examples/fake_bitly/Rakefile
+- examples/fake_bitly/config.ru
+- examples/fake_bitly/lib/fake_bitly.rb
+- examples/fake_bitly/spec/fake_bitly_spec.rb
+- examples/fake_bitly/vcr/shorten.yml
 - fakeapi.gemspec
 - lib/fakeapi.rb
+- lib/fakeapi/app.rb
+- lib/fakeapi/generator.rb
+- lib/fakeapi/json_writer.rb
+- lib/fakeapi/test_run.rb
 - lib/fakeapi/version.rb
+- spec/fakeapi/generator_spec.rb
+- spec/fakeapi/json_writer_spec.rb
+- spec/fakeapi/test_run_spec.rb
 homepage: ''
 licenses: []
 post_install_message: 
@@ -38,17 +198,25 @@ required_ruby_version: !ruby/object:Gem::Requirement
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
+      segments:
+      - 0
+      hash: 3057897862326571822
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
+      segments:
+      - 0
+      hash: 3057897862326571822
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.24
 signing_key: 
 specification_version: 3
 summary: FakeAPI
-test_files: []
-has_rdoc: 
+test_files:
+- spec/fakeapi/generator_spec.rb
+- spec/fakeapi/json_writer_spec.rb
+- spec/fakeapi/test_run_spec.rb