rester 0.3.3 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: feecdb5b8bdfda29d9df2683370a79eb805365ef
-  data.tar.gz: e56faba40a47774b17e4db017ec4b7b2fb09213a
+  metadata.gz: 00fb4dde16f074048bf41f0f245bfb9e7838fe57
+  data.tar.gz: 812ec217d03ff554627fd79713fd1e15cec8ee9a
 SHA512:
-  metadata.gz: 32e24fa563229bcad341c0b06668c67e93fd96196124bcc74e23a1b9d4222765a82d95179d97ad7b9a7430a9c78af85660c66620c433b49ae55ad21220b61aeb
-  data.tar.gz: 57982fbf4923f471ddaf64387d4de8b4ede4c1f12f8654ca3dbdc963fa6490cb0998e19fe173099c4cde289bb6c381a9635c7e36f6df04eda300157af1e6ff0f
+  metadata.gz: 3753b97185a0000bcfc4368564873ff452c8ff989bd6f59d7a7959408b0346d3cbc4c61e6c6812ae138aefb63cf17f31be81ab8ee129a568bce1b51629609645
+  data.tar.gz: 2a24cbc7e691e0c64a93a6d35b97a94945614b6bf43284c28b126c9afbdfde34dc211dbd42f78f0288e2f8e2b62da8b96333224eb67b8c09ebb9767c46c9ee31

data/lib/rester/client/adapters/stub_adapter.rb

@@ -18,7 +18,7 @@ module Rester
       end # Class Methods
 
       def connect(stub_filepath, opts={})
-        @stub = YAML.load_file(stub_filepath)
+        @stub = Utils::StubFile.new(stub_filepath)
       end
 
       def connected?
@@ -41,17 +41,17 @@ module Rester
         _request('DELETE', path, params)
       end
 
-      def with_context(context, &block)
+      def with_context(context)
         @_context = context
-        yield block
+        yield
         @_context = nil
       end
 
       private
 
       def _request(verb, path, params)
-        response = _process_request(path, verb, params)
-        [response['code'], response['body'].to_json]
+        spec = _process_request(path, verb, params)
+        [spec['response_code'], spec['response'].to_json]
       end
 
       def _process_request(path, verb, params)
@@ -72,9 +72,8 @@ module Rester
         end
 
         # At this point, the 'request' is valid by matching a corresponding
-        # request in the stub yaml file. Grab the response from the file and
-        # reset the context
-        stub[path][verb][context]['response']
+        # request in the stub yaml file.
+        stub[path][verb][context]
       end
 
       ##

data/lib/rester/client/response.rb

@@ -1,26 +1,32 @@
 module Rester
   class Client
-    class Response < Hash
+    class Response
       def initialize(status, hash={})
         @_status = status
-        merge!(hash)
-        _deep_freeze
+        @_data = hash.dup || {}
+        Utils.deep_freeze(@_data)
+        freeze
       end
 
       def successful?
         @_status && @_status.between?(200, 299)
       end
 
-      private
+      def to_h
+        @_data.dup
+      end
 
-      def _deep_freeze(value=self)
-        value.freeze
+      def ==(obj)
+        @_data == obj
+      end
+
+      private
 
-        case value
-        when Hash
-          value.values.each { |v| _deep_freeze(v) }
-        when Array
-          value.each { |v| _deep_freeze(v) }
+      def method_missing(meth, *args, &block)
+        if @_data.respond_to?(meth)
+          @_data.public_send(meth, *args, &block)
+        else
+          super
         end
       end
     end # Response

data/lib/rester/rspec.rb

@@ -4,12 +4,13 @@ RSpec.configure do |config|
   config.before :all, rester: // do |ex|
     # Load the stub file
     @rester_stub_filepath = ex.class.metadata[:rester]
-    @rester_stub = YAML.load_file(@rester_stub_filepath)
+    @rester_stub = Rester::Utils::StubFile.new(@rester_stub_filepath)
 
     # Hook up the LocalAdapter with the Service being tested
     unless (klass = ex.class.described_class) < Rester::Service
       raise "invalid service to test"
     end
+
     @rester_adapter = Rester::Client::Adapters::LocalAdapter.new(klass, {})
 
     _validate_test_coverage(ex)
@@ -35,8 +36,7 @@ RSpec.configure do |config|
     }.compact
 
     begin
-      stub_params       = @rester_stub[path][verb][context]['request']
-      raw_stub_response = @rester_stub[path][verb][context]['response']
+      spec = @rester_stub[path][verb][context]
     rescue NoMethodError
       fail Rester::Errors::StubError,
         "Could not find path: #{path.inspect} verb: #{verb.inspect} context: "\
@@ -47,7 +47,7 @@ RSpec.configure do |config|
     # Raw response from the service.
     # [HTTP CODE, JSON String]
     ex.example_group.let(:raw_service_response) {
-      @rester_adapter.request(verb.downcase.to_sym, path, stub_params)
+      @rester_adapter.request(verb.downcase.to_sym, path, spec['request'])
     }
 
     ##
@@ -63,13 +63,12 @@ RSpec.configure do |config|
     ##
     # Expected response body specified in by the stub.
     ex.example_group.let(:stub_response) {
-      JSON.parse((raw_stub_response['body'] || {}).to_json,
-        symbolize_names: true)
+      JSON.parse((spec['response'] || {}).to_json, symbolize_names: true)
     }
 
     ##
     # HTTP status code expected by the stub.
-    ex.example_group.let(:stub_response_code) { raw_stub_response['code'] }
+    ex.example_group.let(:stub_response_code) { spec['response_code'] }
 
     ##
     # Set the subject to be the service response (parsed ruby hash of the

data/lib/rester/service/resource/params.rb

@@ -1,12 +1,13 @@
 module Rester
   class Service::Resource
     class Params
+      DEFAULT_OPTS = { strict: true }.freeze
       BASIC_TYPES = [String, Symbol, Float, Integer].freeze
 
       attr_reader :options
 
       def initialize(opts={}, &block)
-        @options = opts.dup.freeze
+        @options = DEFAULT_OPTS.merge(opts).freeze
         @_required_fields = []
         @_defaults = {}
         @_all_fields = []

data/lib/rester/service/resource.rb

@@ -64,7 +64,8 @@ module Rester
 
         def method_added(method_name)
           if RESOURCE_METHODS.include?(method_name.to_sym)
-            method_params[method_name.to_sym] = (@_next_params || Params.new).freeze
+            method_params[method_name.to_sym] = (@_next_params ||
+              Params.new(strict: false)).freeze
           end
           @_next_params = nil
         end

data/lib/rester/utils/stub_file.rb

@@ -0,0 +1,101 @@
+module Rester
+  module Utils
+    class StubFile
+      DEFAULT_TAGS = { 'successful' => 'true' }.freeze
+
+      attr_reader :path
+
+      def initialize(path)
+        @path = path
+        @_stub = StubFile.parse(path)
+      end
+
+      private
+
+      def method_missing(meth, *args, &block)
+        if @_stub.respond_to?(meth)
+          @_stub.public_send(meth, *args, &block)
+        else
+          super
+        end
+      end
+
+      ##
+      # Class Methods
+      class << self
+        ##
+        # Parses the stub file and returns the data as a hash
+        def parse(path)
+          parse!(YAML.load_file(path))
+        end
+
+        ##
+        # Given a raw stub file hash, converts it to the format used internally.
+        def parse!(stub_hash)
+          stub_hash.each do |path, verbs|
+            next if ['version', 'consumer', 'producer'].include?(path)
+
+            verbs.each do |verb, contexts|
+              contexts.each do |context, spec|
+                _update_context(path, verb, context, spec)
+              end
+            end
+          end
+        end
+
+        ##
+        # Given a context hash, updates it for consumption by the rest of the
+        # StubAdapter (i.e., removes tags from "response" key and puts them in
+        # a "response_tags" key).
+        def _update_context(path, verb, context, spec)
+          responses = spec.select { |k,_|
+            k =~ /\Aresponse(\[(\w+) *= *(\w+)(, *(\w+) *= *(\w+))*\])?\z/
+          }
+
+          if responses.count == 0
+            fail Errors::StubError, "#{verb.upcase} #{path} is missing a " \
+              "response for the context #{context.inspect}"
+          elsif responses.count > 1
+            fail Errors::StubError, "#{verb.upcase} #{path} has too many " \
+              "responses defined for the context #{context.inspect}"
+          end
+
+          response_key = responses.keys.first
+
+          tags = _parse_tags(path, verb, context, response_key)
+
+          spec.merge!(
+            'response' => spec.delete(response_key),
+            'response_tags' => tags,
+            'response_code' => _parse_response_code(verb, tags)
+          )
+        end
+
+        ##
+        # Takes a response key (e.g., "response[successful=false]") and parses out
+        # the tags (e.g., {"successful" => false})
+        def _parse_tags(path, verb, context, resp_key)
+          DEFAULT_TAGS.merge(resp_key.scan(/(\w+) *= *(\w+)/).to_h).tap { |tags|
+            _validate_tags(path, verb, context, tags)
+          }
+        end
+
+        def _validate_tags(path, verb, context, tags)
+          unless ['true', 'false'].include?(tags['successful'])
+            fail Errors::StubError, '"successful" tag should be either "true" '\
+              'or "false" in' "#{verb.upcase} #{path} in context " \
+              "#{context.inspect}"
+          end
+        end
+
+        def _parse_response_code(verb, tags)
+          if tags['successful'] == 'true'
+            (verb == 'POST') ? 201 : 200
+          else
+            400
+          end
+        end
+      end # Class Methods
+    end # StubFile
+  end # Utils
+end # Rester

data/lib/rester/utils.rb

@@ -2,6 +2,8 @@ require 'date'
 
 module Rester
   module Utils
+    autoload(:StubFile,  'rester/utils/stub_file')
+
     class << self
       ##
       # Determines the HTTP method/verb based on the method name.
@@ -65,6 +67,17 @@ module Rester
       def underscore(str)
         str.scan(/[A-Z][a-z]*/).map(&:downcase).join('_')
       end
+
+      def deep_freeze(value)
+        value.freeze
+
+        case value
+        when Hash
+          value.values.each { |v| deep_freeze(v) }
+        when Array
+          value.each { |v| deep_freeze(v) }
+        end
+      end
     end # Class methods
   end # Utils
 end # Rester

data/lib/rester/version.rb

@@ -1,3 +1,3 @@
 module Rester
-  VERSION = '0.3.3'
+  VERSION = '0.4.0'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rester
 version: !ruby/object:Gem::Version
-  version: 0.3.3
+  version: 0.4.0
 platform: ruby
 authors:
 - Robert Honer
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-11-13 00:00:00.000000000 Z
+date: 2015-11-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rack
@@ -145,6 +145,7 @@ files:
 - lib/rester/service/resource.rb
 - lib/rester/service/resource/params.rb
 - lib/rester/utils.rb
+- lib/rester/utils/stub_file.rb
 - lib/rester/version.rb
 homepage: http://github.com/payout/rester
 licenses: