lyre 0.0.0 → 0.0.1

data/.gitignore

@@ -1,3 +1,6 @@
+#ignore any TODO files
+*.todo
+
 #ignore the build directory
 /pkg
 

data/Gemfile.lock

@@ -2,15 +2,39 @@ PATH
   remote: .
   specs:
     lyre (0.0.0)
+      capybara
       sinatra
 
 GEM
   remote: http://rubygems.org/
   specs:
+    capybara (2.0.2)
+      mime-types (>= 1.16)
+      nokogiri (>= 1.3.3)
+      rack (>= 1.0.0)
+      rack-test (>= 0.5.4)
+      selenium-webdriver (~> 2.0)
+      xpath (~> 1.0.0)
+    childprocess (0.3.8)
+      ffi (~> 1.0, >= 1.0.11)
+    columnize (0.3.6)
+    debugger (1.3.1)
+      columnize (>= 0.3.1)
+      debugger-linecache (~> 1.1.1)
+      debugger-ruby_core_source (~> 1.1.8)
+    debugger-linecache (1.1.2)
+      debugger-ruby_core_source (>= 1.1.1)
+    debugger-ruby_core_source (1.1.8)
     diff-lcs (1.1.3)
+    ffi (1.3.1)
+    mime-types (1.21)
+    multi_json (1.6.0)
+    nokogiri (1.5.6)
     rack (1.5.2)
     rack-protection (1.3.2)
       rack
+    rack-test (0.6.2)
+      rack (>= 1.0)
     rake (10.0.3)
     rspec (2.12.0)
       rspec-core (~> 2.12.0)
@@ -20,16 +44,26 @@ GEM
     rspec-expectations (2.12.1)
       diff-lcs (~> 1.1.3)
     rspec-mocks (2.12.2)
+    rubyzip (0.9.9)
+    selenium-webdriver (2.29.0)
+      childprocess (>= 0.2.5)
+      multi_json (~> 1.0)
+      rubyzip
+      websocket (~> 1.0.4)
     sinatra (1.3.4)
       rack (~> 1.4)
       rack-protection (~> 1.3)
       tilt (~> 1.3, >= 1.3.3)
     tilt (1.3.3)
+    websocket (1.0.7)
+    xpath (1.0.0)
+      nokogiri (~> 1.3)
 
 PLATFORMS
   ruby
 
 DEPENDENCIES
+  debugger
   lyre!
   rake
   rspec

data/README.md

@@ -0,0 +1,8 @@
+# Notes
+
+http://robots.thoughtbot.com/post/34761570235/using-capybara-to-test-javascript-that-makes-http
+
+Check out the set_configuration call below:
+https://github.com/thoughtbot/fake_braintree/blob/master/lib/fake_braintree.rb
+
+http://www.sinatrarb.com/intro#Rack%20Middleware

data/Rakefile

@@ -13,5 +13,5 @@ task :default => [:spec]
 
 desc "Clean build artifacts"
 task :clean do
-  `rm *.gem`
+  `rm pkg/*.gem`
 end

data/lib/lyre/app.rb

@@ -0,0 +1,55 @@
+require 'lyre/registry'
+require 'sinatra'
+
+module Lyre
+
+  #NOTE: Not sure this is the right name for this class
+  class App < Sinatra::Base
+
+    attr_accessor :host, :port
+
+    class << self
+      attr_accessor :setup_block, :teardown_block
+
+      def setup(&block)
+        self.setup_block = block
+      end
+
+      def teardown(&block)
+        self.teardown_block = block
+      end
+
+      alias_method :create, :new! #Sinatra redefines new as new!, so make it easy to access
+    end
+
+    def start
+      return if started?
+      Lyre::Registry.register_and_run self
+      self.instance_eval(&self.class.setup_block) if self.class.setup_block
+      self.started = true
+      self
+    end
+
+    def stop
+      return unless started?
+      Lyre::Registry.stop_and_deregister self
+      self.instance_eval(&self.class.teardown_block) if self.class.teardown_block
+      self.started = false
+      self
+    end
+
+    def endpoint
+      "http://#{host}:#{port}" #may want to make http/https configurable
+    end
+
+    def started?
+      started
+    end
+
+    private
+
+    attr_accessor :started
+    
+  end
+
+end

data/lib/lyre/constants.rb

@@ -0,0 +1,3 @@
+module Lyre
+  START_PORT = 49_152
+end

data/lib/lyre/registry.rb

@@ -0,0 +1,27 @@
+require 'capybara'
+
+module Lyre
+  module Registry
+
+    @@registry = {}
+
+    def self.register_and_run(lyre)
+      raise "Lyre already registered" if @@registry.has_key? lyre.class
+
+      @@registry[lyre.class] = Capybara::Server.new(lyre).tap do |server|
+        server.boot
+
+        lyre.host = server.host
+        lyre.port = server.port
+      end
+    end
+
+    def self.stop_and_deregister(lyre)
+      raise "Lyre not registered" unless @@registry.has_key? lyre.class
+
+      #server cannot be stopped
+
+      @@registry.delete(lyre.class)
+    end
+  end
+end

data/lib/lyre/version.rb

@@ -1,3 +1,3 @@
 module Lyre
-  VERSION = '0.0.0'
+  VERSION = '0.0.1'
 end

data/lib/lyre.rb

@@ -1 +1,3 @@
 require 'lyre/version'
+require 'lyre/constants'
+require 'lyre/app'

data/lyre.gemspec

@@ -18,7 +18,9 @@ Gem::Specification.new do |s|
   s.require_paths = ['lib']
 
   s.add_dependency 'sinatra'
+  s.add_dependency 'capybara'
 
   s.add_development_dependency 'rake'
   s.add_development_dependency 'rspec'
+  s.add_development_dependency 'debugger'
 end

data/spec/end_to_end_spec.rb

@@ -0,0 +1,17 @@
+require 'spec_helper'
+
+describe 'End to end test - Refactor later' do
+  
+  before(:all) do
+    @lyre = FakeServiceLyre.create.start
+  end
+
+  after(:all) do
+    @lyre.stop
+  end
+
+  it "should mock the endpoint that FakeService tries to access" do
+    FakeService.call_service.should == 'Hello World'
+  end
+
+end

data/spec/fake_service_spec.rb

@@ -0,0 +1,7 @@
+require 'spec_helper'
+
+describe FakeService do
+  it "should return an empty string when default values are used" do
+    expect { FakeService.call_service }.to raise_error(SocketError, 'getaddrinfo: nodename nor servname provided, or not known')
+  end
+end

data/spec/lifecycle_spec.rb

@@ -0,0 +1,47 @@
+require 'spec_helper'
+
+describe "Lifecycle Tests" do
+
+  describe "setup and teardown are called" do
+    before(:each) { @lyre = LifeCycleLyre.create.start }
+    after(:each) { @lyre.stop }
+
+    it "should call setup block when the lyre is started" do
+      LifeCycleLyre.setup_called.should be_true
+    end
+
+    it "should call teardown block when the lyre is stopped" do
+      @lyre.stop
+
+      LifeCycleLyre.setup_called.should be_true   
+    end
+  end
+
+  describe "setup and teardown are optional" do
+    before(:each) { @lyre = NoLifeCycleLyre.create }
+    after(:each) { @lyre.stop }
+
+    it "should not fail if the lyre has no setup" do
+      @lyre.start
+    end
+
+    it "should not fail of the lyre has no teardown" do
+      @lyre.stop
+    end
+  end
+
+  describe "start and stop are idempotent" do
+    before(:each) { @lyre = NoLifeCycleLyre.create }
+    after(:each) { @lyre.stop }
+
+    it "should allow start to be called twice" do
+      @lyre.start.start
+    end
+
+    it "should allow stop to be called twice" do
+      @lyre.start.stop.stop
+    end
+
+  end
+
+end

data/spec/registration_spec.rb

@@ -0,0 +1,20 @@
+require 'spec_helper'
+
+describe "Lyre registration" do
+
+  before(:each) do
+    @lyre_one = FakeServiceLyre.create
+    @lyre_two = FakeServiceLyre.create
+  end
+
+  after(:each) do
+    @lyre_one.stop
+    @lyre_two.stop
+  end
+
+  it "should not allow two instances of the same lyre to run simultaneously" do
+    @lyre_one.start
+    expect { @lyre_two.start }.to raise_error('Lyre already registered')
+  end
+
+end

data/spec/spec_helper.rb

@@ -1,5 +1,9 @@
-require 'rspec'
+require 'lyre'
 
 PROJECT_ROOT = File.expand_path(File.join(File.dirname(__FILE__), '..')).freeze
 
 Dir[File.join(PROJECT_ROOT, 'spec', 'support', '**', '*.rb')].each { |file| require(file) }
+
+RSpec.configure do |config|
+  config.order = :random
+end

data/spec/support/fake_service.rb

@@ -4,7 +4,7 @@ class FakeService
 
   class << self
     def endpoint
-      @endpoint || 'example.com'
+      @endpoint || 'http://nowhere.example.com'
     end
 
     def endpoint=(value)
@@ -12,7 +12,9 @@ class FakeService
     end
 
     def call_service
-      http = Net::HTTP.new(endpoint)
+      url = URI.parse(endpoint)
+
+      http = Net::HTTP.new(url.host, url.port)
       request = Net::HTTP::Get.new("/")
       response = http.request(request)
 

data/spec/support/fake_service_lyre.rb

@@ -0,0 +1,16 @@
+class FakeServiceLyre < Lyre::App
+
+  setup do
+    @original_endpoint = FakeService.endpoint
+    FakeService.endpoint = endpoint
+  end
+
+  teardown do
+    FakeService.endpoint = @original_endpoint
+  end
+
+  get '/' do
+    'Hello World'
+  end
+
+end

data/spec/support/life_cycle_lyre.rb

@@ -0,0 +1,27 @@
+class LifeCycleLyre < Lyre::App
+
+  setup do
+    LifeCycleLyre.setup_called = true
+  end
+
+  teardown do
+    LifeCycleLyre.teardown_called = true
+  end
+
+  def self.setup_called
+    @@setup_called
+  end
+
+  def self.setup_called=(value)
+    @@setup_called = value
+  end
+
+  def self.teardown_called
+    @@teardown_called
+  end
+
+  def self.teardown_called=(value)
+    @@teardown_called = value
+  end
+
+end

data/spec/support/no_life_cycle_lyre.rb

@@ -0,0 +1,2 @@
+class NoLifeCycleLyre < Lyre::App
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: lyre
 version: !ruby/object:Gem::Version
-  version: 0.0.0
+  version: 0.0.1
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-02-11 00:00:00.000000000 Z
+date: 2013-02-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: sinatra
@@ -27,6 +27,22 @@ dependencies:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: capybara
+  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
@@ -59,6 +75,22 @@ dependencies:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: debugger
+  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: Awesome mocks of external REST API dependencies
 email:
 - dev@sortfolio.com
@@ -70,12 +102,23 @@ files:
 - .rvmrc
 - Gemfile
 - Gemfile.lock
+- README.md
 - Rakefile
 - lib/lyre.rb
+- lib/lyre/app.rb
+- lib/lyre/constants.rb
+- lib/lyre/registry.rb
 - lib/lyre/version.rb
 - lyre.gemspec
+- spec/end_to_end_spec.rb
+- spec/fake_service_spec.rb
+- spec/lifecycle_spec.rb
+- spec/registration_spec.rb
 - spec/spec_helper.rb
 - spec/support/fake_service.rb
+- spec/support/fake_service_lyre.rb
+- spec/support/life_cycle_lyre.rb
+- spec/support/no_life_cycle_lyre.rb
 homepage: ''
 licenses: []
 post_install_message: 
@@ -101,5 +144,12 @@ signing_key:
 specification_version: 3
 summary: Awesome mocks of external REST API dependencies
 test_files:
+- spec/end_to_end_spec.rb
+- spec/fake_service_spec.rb
+- spec/lifecycle_spec.rb
+- spec/registration_spec.rb
 - spec/spec_helper.rb
 - spec/support/fake_service.rb
+- spec/support/fake_service_lyre.rb
+- spec/support/life_cycle_lyre.rb
+- spec/support/no_life_cycle_lyre.rb