shokkenki 0.0.0

data/lib/shokkenki/configuration.rb

@@ -0,0 +1,5 @@
+module Shokkenki
+  class Configuration
+    attr_accessor :ticket_location
+  end
+end

data/lib/shokkenki/consumer/consumer_role.rb

@@ -0,0 +1,26 @@
+require 'shokkenki/consumer/patronage'
+require 'shokkenki/consumer/simplification'
+
+module Shokkenki
+  module Consumer
+    class ConsumerRole
+      include Shokkenki::Consumer::Simplification
+
+      attr_reader :name, :patronages
+
+      def initialize arguments
+        @name = simplify(arguments[:name])
+        @patronages = {}
+      end
+
+      def patronage provider_name
+        @patronages[simplify(provider_name)] ||= Shokkenki::Consumer::Patronage.new :name => provider_name, :consumer => self
+      end
+
+      def tickets
+        @patronages.values.collect &:ticket
+      end
+
+    end
+  end
+end

data/lib/shokkenki/consumer/interaction.rb

@@ -0,0 +1,24 @@
+require 'shokkenki/consumer/request'
+require 'shokkenki/consumer/response'
+
+module Shokkenki
+  module Consumer
+    class Interaction
+
+      attr_reader :label, :request, :response
+
+      def initialize attributes
+        @label = attributes[:label]
+      end
+
+      def requested_with request_attributes
+        @request = Shokkenki::Consumer::Request.new request_attributes
+      end
+
+      def responds_with response_attributes
+        @response = Shokkenki::Consumer::Response.new response_attributes
+      end
+
+    end
+  end
+end

data/lib/shokkenki/consumer/patronage.rb

@@ -0,0 +1,29 @@
+require 'shokkenki/consumer/ticket'
+require 'shokkenki/consumer/interaction'
+require 'shokkenki/consumer/simplification'
+
+module Shokkenki
+  module Consumer
+    class Patronage
+      include Shokkenki::Consumer::Simplification
+
+      attr_reader :name, :consumer
+
+      def initialize attributes
+        @name = simplify(attributes[:name])
+        @consumer = attributes[:consumer]
+        @interactions = []
+      end
+
+      def during interaction_label
+        interaction = Interaction.new(:label => interaction_label)
+        @interactions << interaction
+        interaction
+      end
+
+      def ticket
+        Ticket.new :consumer => @consumer.name, :provider => @name
+      end
+    end
+  end
+end

data/lib/shokkenki/consumer/request.rb

@@ -0,0 +1,14 @@
+module Shokkenki
+  module Consumer
+    class Request
+
+      attr_reader :method_type, :path
+
+      def initialize attributes
+        @method_type = attributes[:method]
+        @path = attributes[:path]
+      end
+
+    end
+  end
+end

data/lib/shokkenki/consumer/response.rb

@@ -0,0 +1,11 @@
+module Shokkenki
+  module Consumer
+    class Response
+
+      def initialize attributes
+
+      end
+
+    end
+  end
+end

data/lib/shokkenki/consumer/rspec/example_group_binding.rb

@@ -0,0 +1,14 @@
+require 'shokkenki/consumer/session'
+require 'shokkenki/consumer/consumer_role'
+
+module Shokkenki
+  module Consumer
+    module RSpec
+      module ExampleGroupBinding
+        def shokkenki
+          Shokkenki::Consumer::Session.singleton
+        end
+      end
+    end
+  end
+end

data/lib/shokkenki/consumer/rspec/rspec_configuration.rb

@@ -0,0 +1,13 @@
+require 'shokkenki/consumer/rspec/example_group_binding'
+require 'rspec'
+
+RSpec.configure do |config|
+  config.treat_symbols_as_metadata_keys_with_true_values = true
+  config.include Shokkenki::Consumer::RSpec::ExampleGroupBinding
+
+  config.before(:each, :shokkenki_consumer => lambda{ |x| true }) do
+    Shokkenki::Consumer::Session.singleton.current_consumer = example.metadata[:shokkenki_consumer]
+  end
+
+  config.after(:suite) { Shokkenki::Consumer::Session.singleton.print_tickets }
+end

data/lib/shokkenki/consumer/rspec.rb

@@ -0,0 +1,2 @@
+# for cosmetic reasons so that clients don't have to require shokkenki/consumer/rspec/rspec
+require 'shokkenki/consumer/rspec/rspec_configuration'

data/lib/shokkenki/consumer/session.rb

@@ -0,0 +1,50 @@
+require 'shokkenki/consumer/consumer_role'
+require 'shokkenki/shokkenki'
+require 'shokkenki/consumer/simplification'
+
+module Shokkenki
+  module Consumer
+    class Session
+      include Shokkenki::Consumer::Simplification
+
+      attr_reader :consumers, :current_consumer
+
+      def initialize
+        @consumers = {}
+      end
+
+      def self.singleton
+        @instance ||= Session.new
+      end
+
+      def provider provider_name
+        @current_consumer.patronage provider_name
+      end
+
+      def current_consumer= consumer_attributes
+        name = simplify(consumer_attributes[:name])
+        @consumers[name] ||= Shokkenki::Consumer::ConsumerRole.new consumer_attributes
+        @current_consumer = @consumers[name]
+      end
+
+      def stamped_tickets
+        time = Time.now
+        # would rather copy + transform tickets rather than modify
+        # existing state - something to come back to
+        @consumers.values.collect(&:tickets).flatten.map do |ticket|
+          ticket.version = Shokkenki::Version::STRING
+          ticket.time = time
+          ticket
+        end
+      end
+
+      def print_tickets
+        stamped_tickets.each do |ticket|
+          ticket_path = File.expand_path(File.join(Shokkenki.configuration.ticket_location, ticket.filename))
+          File.open(ticket_path, 'w') { |file| file.write(ticket.to_json) }
+        end
+      end
+
+    end
+  end
+end

data/lib/shokkenki/consumer/simplification.rb

@@ -0,0 +1,14 @@
+module Shokkenki
+  module Consumer
+    module Simplification
+      def simplify name
+        name.to_s.
+          strip.
+          gsub(' ', '_').
+          gsub(/\W/, '').
+          downcase.
+          to_sym if name
+      end
+    end
+  end
+end

data/lib/shokkenki/consumer/ticket.rb

@@ -0,0 +1,38 @@
+require 'json'
+require 'time'
+
+module Shokkenki
+  module Consumer
+    class Ticket
+
+      attr_reader :provider, :consumer
+      attr_accessor :time, :version
+
+      def initialize attributes
+        @provider = attributes[:provider]
+        @consumer = attributes[:consumer]
+      end
+
+      def filename
+        "#{@consumer}-#{@provider}.json"
+      end
+
+      def to_hash
+        {
+          :consumer => {
+            :name => @consumer
+          },
+          :provider => {
+            :name => @provider
+          },
+          :time => @time.utc.iso8601,
+          :version => @version
+        }
+      end
+
+      def to_json
+        to_hash.to_json
+      end
+    end
+  end
+end

data/lib/shokkenki/shokkenki.rb

@@ -0,0 +1,12 @@
+require 'shokkenki/configuration'
+
+module Shokkenki
+
+  def self.configuration
+    @configuration ||= Shokkenki::Configuration.new
+  end
+
+  def self.configure
+    yield configuration if block_given?
+  end
+end

data/lib/shokkenki/version.rb

@@ -0,0 +1,5 @@
+module Shokkenki
+  module Version
+    STRING = '0.0.0'
+  end
+end

metadata

@@ -0,0 +1,143 @@
+--- !ruby/object:Gem::Specification
+name: shokkenki
+version: !ruby/object:Gem::Version
+  version: 0.0.0
+  prerelease: 
+platform: ruby
+authors:
+- Brent Snook
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-10-07 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: json
+  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: 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
+- !ruby/object:Gem::Dependency
+  name: json
+  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: timecop
+  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: Consumer-driven contracts recorded from real examples.
+email: brent@fuglylogic.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/shokkenki/configuration.rb
+- lib/shokkenki/consumer/consumer_role.rb
+- lib/shokkenki/consumer/interaction.rb
+- lib/shokkenki/consumer/patronage.rb
+- lib/shokkenki/consumer/request.rb
+- lib/shokkenki/consumer/response.rb
+- lib/shokkenki/consumer/rspec.rb
+- lib/shokkenki/consumer/rspec/example_group_binding.rb
+- lib/shokkenki/consumer/rspec/rspec_configuration.rb
+- lib/shokkenki/consumer/session.rb
+- lib/shokkenki/consumer/simplification.rb
+- lib/shokkenki/consumer/ticket.rb
+- lib/shokkenki/shokkenki.rb
+- lib/shokkenki/version.rb
+homepage: http://github.com/brentsnook/shokkenki
+licenses:
+- MIT
+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.8.7
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: -4031148388905452257
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.24
+signing_key: 
+specification_version: 3
+summary: shokkenki-0.0.0
+test_files: []