shokkenki-provider 0.0.2

data/lib/shokkenki/provider/configuration/provider.rb

@@ -0,0 +1,17 @@
+require_relative '../model/rack_http_client'
+
+module Shokkenki
+  module Provider
+    module Configuration
+      module Provider
+        def run app
+          self.http_client = Shokkenki::Provider::Model::RackHttpClient.new app
+        end
+
+        def given match, &block
+          add_fixture match, block
+        end
+      end
+    end
+  end
+end

data/lib/shokkenki/provider/configuration/session.rb

@@ -0,0 +1,24 @@
+require_relative '../model/provider'
+
+module Shokkenki
+  module Provider
+    module Configuration
+      module Session
+
+        def configure &block
+          instance_eval &block
+        end
+
+        def tickets location
+          self.ticket_location = location
+        end
+
+        def provider name, &block
+          provider = providers[name] || Shokkenki::Provider::Model::Provider.new(name)
+          provider.instance_eval &block if block
+          add_provider provider
+        end
+      end
+    end
+  end
+end

data/lib/shokkenki/provider/model/fixture.rb

@@ -0,0 +1,33 @@
+module Shokkenki
+  module Provider
+    module Model
+      class Fixture
+
+        def initialize name_pattern, establisher
+          @name_pattern = name_pattern
+          @establisher = establisher
+          validate!
+        end
+
+        def establish required_fixture
+          match = @name_pattern.match required_fixture.name
+          if match
+            arguments = {
+              :arguments => required_fixture.arguments,
+              :match => match
+            }
+            @establisher.call arguments
+          end
+        end
+
+        private
+
+        def validate!
+          message = "Fixture establisher for name pattern /#{@name_pattern}/ must only accept zero or one argument."
+          raise message unless @establisher.arity <= 1
+        end
+
+      end
+    end
+  end
+end

data/lib/shokkenki/provider/model/fixture_requirement.rb

@@ -0,0 +1,22 @@
+require 'active_support/core_ext/hash/keys'
+
+module Shokkenki
+  module Provider
+    module Model
+      class FixtureRequirement
+
+        attr_reader :name, :arguments
+
+        def initialize name, arguments
+          @name = name
+          @arguments = arguments
+        end
+
+        def self.from_hash hash
+          symbolized_hash = hash.deep_symbolize_keys
+          new symbolized_hash[:name], symbolized_hash[:arguments]
+        end
+      end
+    end
+  end
+end

data/lib/shokkenki/provider/model/interaction.rb

@@ -0,0 +1,28 @@
+require 'shokkenki/term/term_factory'
+require_relative 'fixture_requirement'
+
+module Shokkenki
+  module Provider
+    module Model
+      class Interaction
+        attr_reader :label, :response, :request, :required_fixtures
+
+        def initialize label, request, response, required_fixtures
+          @label = label
+          @request = request
+          @response = response
+          @required_fixtures = required_fixtures
+        end
+
+        def self.from_hash hash
+          new(
+            hash[:label],
+            Shokkenki::Term::TermFactory.from_json(hash[:request]),
+            Shokkenki::Term::TermFactory.from_json(hash[:response]),
+            hash[:fixtures].map {|f| FixtureRequirement.from_hash f }
+          )
+        end
+      end
+    end
+  end
+end

data/lib/shokkenki/provider/model/provider.rb

@@ -0,0 +1,29 @@
+require_relative '../configuration/provider'
+require_relative 'fixture'
+
+module Shokkenki
+  module Provider
+    module Model
+      class Provider
+        include Shokkenki::Provider::Configuration::Provider
+        attr_reader :name, :fixtures
+        attr_accessor :http_client
+
+        def initialize name
+          @name = name
+          @fixtures = []
+        end
+
+        def add_fixture name_pattern, fixture
+          @fixtures << Fixture.new(name_pattern, fixture)
+        end
+
+        def establish required_fixtures
+          required_fixtures.each do |required_fixture|
+            @fixtures.each { |fixture| fixture.establish required_fixture }
+          end
+        end
+      end
+    end
+  end
+end

data/lib/shokkenki/provider/model/rack_http_client.rb

@@ -0,0 +1,39 @@
+require 'rack/test'
+require 'faraday'
+
+module Shokkenki
+  module Provider
+    module Model
+      class RackHttpClient
+
+        def initialize app
+          @connection = Faraday.new do |f|
+            f.adapter :rack, app
+          end
+        end
+
+        def response_for request_term
+          request = request_term.example
+          response = @connection.send(request.delete(:method).to_sym) do |r|
+            request.each do |key, value|
+              writer = (key == :query) ? :params= : "#{key}=".to_sym
+              r.send writer, value
+            end
+          end
+
+          as_shokkenki_response response
+        end
+
+        private
+
+        def as_shokkenki_response response
+          {
+            :status => response.status,
+            :headers => response.headers,
+            :body => response.body
+          }
+        end
+      end
+    end
+  end
+end

data/lib/shokkenki/provider/model/role.rb

@@ -0,0 +1,19 @@
+module Shokkenki
+  module Provider
+    module Model
+      class Role
+
+        attr_reader :name, :label
+
+        def self.from_hash hash
+          new(hash[:name], hash[:label])
+        end
+
+        def initialize name, label
+          @name = name
+          @label = label
+        end
+      end
+    end
+  end
+end

data/lib/shokkenki/provider/model/ticket.rb

@@ -0,0 +1,32 @@
+require 'active_support/core_ext/hash/keys'
+require_relative 'role'
+require_relative 'interaction'
+
+module Shokkenki
+  module Provider
+    module Model
+      class Ticket
+
+        attr_reader :provider, :interactions, :consumer
+
+        def initialize provider, consumer, interactions
+          @provider = provider
+          @consumer = consumer
+          @interactions = interactions
+        end
+
+        def self.from_json json
+          from_hash(JSON.parse(json).symbolize_keys)
+        end
+
+        def self.from_hash hash
+          new(
+            Role.from_hash(hash[:provider].symbolize_keys),
+            Role.from_hash(hash[:consumer].symbolize_keys),
+            hash[:interactions].map{ |h| Interaction.from_hash h.symbolize_keys }
+          )
+        end
+      end
+    end
+  end
+end

data/lib/shokkenki/provider/provider.rb

@@ -0,0 +1,9 @@
+require_relative 'session'
+
+module Shokkenki
+
+  def self.provider
+    @provider_session ||= Shokkenki::Provider::Session.new
+  end
+
+end

data/lib/shokkenki/provider/rspec/interaction.rb

@@ -0,0 +1,22 @@
+module Shokkenki
+  module Provider
+    module RSpec
+      module Interaction
+
+        def verify_within context
+          interaction = self
+          context.describe label do
+            before(:all) do
+              @provider.establish interaction.required_fixtures
+
+              @http_response = @provider.http_client.response_for(interaction.request)
+            end
+            before(:each) { @actual_values = [@http_response] }
+            interaction.response.verify_within self
+          end
+        end
+
+      end
+    end
+  end
+end

data/lib/shokkenki/provider/rspec/term/hash_term.rb

@@ -0,0 +1,19 @@
+module Shokkenki
+  module Provider
+    module RSpec
+      module Term
+        module HashTerm
+          def verify_within context
+            value.each do |name, term|
+              context.describe name do
+                before { @actual_values = @actual_values.map{ |value| value[name] } }
+
+                term.verify_within self
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/shokkenki/provider/rspec/term/json_paths_term.rb

@@ -0,0 +1,29 @@
+require 'jsonpath'
+
+module Shokkenki
+  module Provider
+    module RSpec
+      module Term
+        module JsonPathsTerm
+          def verify_within context
+            term = self
+            context.describe 'json value' do
+              term.value.each do |json_path, term|
+                describe json_path do
+
+                  before(:each) do
+                    @actual_values = @actual_values.map do |value|
+                      JsonPath.on(value, json_path)
+                    end.flatten
+                  end
+
+                  term.verify_within self
+                end
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/shokkenki/provider/rspec/term/number_term.rb

@@ -0,0 +1,16 @@
+module Shokkenki
+  module Provider
+    module RSpec
+      module Term
+        module NumberTerm
+          def verify_within context
+            term_value = value
+            context.it %Q{is #{term_value}} do
+              @actual_values.each { |value| expect(value).to(eq(term_value)) }
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/shokkenki/provider/rspec/term/regexp_term.rb

@@ -0,0 +1,16 @@
+module Shokkenki
+  module Provider
+    module RSpec
+      module Term
+        module RegexpTerm
+          def verify_within context
+            term_value = value
+            context.it %Q{matches /#{term_value}/} do
+              @actual_values.each{ |value| expect(value.to_s).to(match(term_value)) }
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/shokkenki/provider/rspec/term/string_term.rb

@@ -0,0 +1,16 @@
+module Shokkenki
+  module Provider
+    module RSpec
+      module Term
+        module StringTerm
+          def verify_within context
+            term_value = value
+            context.it %Q{is "#{term_value}"} do
+              @actual_values.each { |value| expect(value.to_s).to(eq(term_value)) }
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/shokkenki/provider/rspec/ticket.rb

@@ -0,0 +1,19 @@
+require 'rspec/core/dsl'
+
+module Shokkenki
+  module Provider
+    module RSpec
+      module Ticket
+        include ::RSpec::Core::DSL
+
+        def verify_with provider
+          ticket = self
+          describe consumer.label, :shokkenki_provider => true do
+            before(:all) { @provider = provider }
+            ticket.interactions.each { |i| i.verify_within self }
+          end
+        end
+      end
+    end
+  end
+end

data/lib/shokkenki/provider/rspec.rb

@@ -0,0 +1,26 @@
+require_relative 'provider'
+
+require_relative 'model/ticket'
+require_relative 'model/interaction'
+require 'shokkenki/term/hash_term'
+require 'shokkenki/term/string_term'
+require 'shokkenki/term/number_term'
+require 'shokkenki/term/regexp_term'
+require 'shokkenki/term/json_paths_term'
+
+require_relative 'rspec/ticket'
+require_relative 'rspec/interaction'
+require_relative 'rspec/term/hash_term'
+require_relative 'rspec/term/string_term'
+require_relative 'rspec/term/number_term'
+require_relative 'rspec/term/regexp_term'
+require_relative 'rspec/term/json_paths_term'
+
+Shokkenki::Provider::Model::Ticket.send :include, Shokkenki::Provider::RSpec::Ticket
+Shokkenki::Provider::Model::Interaction.send :include, Shokkenki::Provider::RSpec::Interaction
+
+Shokkenki::Term::HashTerm.send :include, Shokkenki::Provider::RSpec::Term::HashTerm
+Shokkenki::Term::StringTerm.send :include, Shokkenki::Provider::RSpec::Term::StringTerm
+Shokkenki::Term::NumberTerm.send :include, Shokkenki::Provider::RSpec::Term::NumberTerm
+Shokkenki::Term::RegexpTerm.send :include, Shokkenki::Provider::RSpec::Term::RegexpTerm
+Shokkenki::Term::JsonPathsTerm.send :include, Shokkenki::Provider::RSpec::Term::JsonPathsTerm

data/lib/shokkenki/provider/session.rb

@@ -0,0 +1,32 @@
+require_relative 'ticket_reader'
+require_relative 'configuration/session'
+require 'active_support/core_ext/hash/indifferent_access'
+
+module Shokkenki
+  module Provider
+    class Session
+      include Shokkenki::Provider::Configuration::Session
+
+      attr_accessor :ticket_location
+      attr_reader :providers
+
+      def initialize
+        @ticket_reader = TicketReader.new
+        @ticket_location = 'tickets'
+        @providers = {}.with_indifferent_access
+      end
+
+      def add_provider provider
+        @providers[provider.name] = provider
+      end
+
+      def redeem_tickets
+        @ticket_reader.read_from(ticket_location).each do |ticket|
+          provider = providers[ticket.provider.name]
+          raise "No provided named '#{ticket.provider.name}' was found. Did you register one?" unless provider
+          ticket.verify_with provider
+        end
+      end
+    end
+  end
+end

data/lib/shokkenki/provider/ticket_reader.rb

@@ -0,0 +1,42 @@
+require_relative 'model/ticket'
+require 'uri'
+require 'open-uri'
+require 'json'
+
+module Shokkenki
+  module Provider
+    class TicketReader
+
+      def read_from location
+        location.respond_to?(:call) ? location.call : parse_from(location)
+      end
+
+      private
+
+      def parse_from resource
+        resource.match(URI::regexp) ? parse_from_remote(resource) : parse_from_local(resource)
+      end
+
+      def parse_from_remote resource
+        open(resource) do |f|
+          JSON.parse(f.read).map { |h| Shokkenki::Provider::Model::Ticket.from_hash h}
+        end
+      end
+
+      def parse_from_local resource
+        Dir.exists?(resource) ? parse_from_directory(resource) : parse_from_file(resource)
+      end
+
+      def parse_from_directory directory
+        Dir.glob("#{directory}/**/*.json").map do |json_file|
+          Shokkenki::Provider::Model::Ticket.from_json File.read(json_file)
+        end
+      end
+
+      def parse_from_file file
+        [Shokkenki::Provider::Model::Ticket.from_json(File.read(file))]
+      end
+
+    end
+  end
+end

data/lib/shokkenki/provider/version.rb

@@ -0,0 +1,7 @@
+module Shokkenki
+  module Provider
+    module Version
+      STRING = '0.0.2'
+    end
+  end
+end

metadata

@@ -0,0 +1,198 @@
+--- !ruby/object:Gem::Specification
+name: shokkenki-provider
+version: !ruby/object:Gem::Version
+  version: 0.0.2
+  prerelease: 
+platform: ruby
+authors:
+- Brent Snook
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-11-26 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rspec
+  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: activesupport
+  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: faraday
+  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: rack-test
+  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: jsonpath
+  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: shokkenki-support
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.0.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.0.2
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 10.0.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 10.0.0
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.14.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.14.0
+description: Example-driven consumer-driven contracts. For providers.
+email: brent@fuglylogic.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/shokkenki/provider/configuration/provider.rb
+- lib/shokkenki/provider/configuration/session.rb
+- lib/shokkenki/provider/model/fixture.rb
+- lib/shokkenki/provider/model/fixture_requirement.rb
+- lib/shokkenki/provider/model/interaction.rb
+- lib/shokkenki/provider/model/provider.rb
+- lib/shokkenki/provider/model/rack_http_client.rb
+- lib/shokkenki/provider/model/role.rb
+- lib/shokkenki/provider/model/ticket.rb
+- lib/shokkenki/provider/provider.rb
+- lib/shokkenki/provider/rspec.rb
+- lib/shokkenki/provider/rspec/interaction.rb
+- lib/shokkenki/provider/rspec/term/hash_term.rb
+- lib/shokkenki/provider/rspec/term/json_paths_term.rb
+- lib/shokkenki/provider/rspec/term/number_term.rb
+- lib/shokkenki/provider/rspec/term/regexp_term.rb
+- lib/shokkenki/provider/rspec/term/string_term.rb
+- lib/shokkenki/provider/rspec/ticket.rb
+- lib/shokkenki/provider/session.rb
+- lib/shokkenki/provider/ticket_reader.rb
+- lib/shokkenki/provider/version.rb
+homepage: http://github.com/brentsnook/shokkenki-provider
+licenses:
+- GPL2
+post_install_message: 
+rdoc_options:
+- --charset=UTF-8
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '1.9'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: -3549391990526076045
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.24
+signing_key: 
+specification_version: 3
+summary: shokkenki-0.0.2
+test_files: []