evil-client 0.2.3 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: d60319bf7209231d32f547d877be87a37a3fda7c
-  data.tar.gz: 14a555f98f491d5909cb3be0e56de4795de16d06
+  metadata.gz: 7709a566e45dfcf398b95933a6d91639fd1ad47d
+  data.tar.gz: fa499f5f9856cb8a451bc87c0ff3f44f41ae7733
 SHA512:
-  metadata.gz: 83e1ac00f591960aaa8c6f117432034261c99d0c7a7789d89aa40523cfed65d001994921ca84a1623b2101342702b279dc7a75eb01b0fe25980446e4668e3a3a
-  data.tar.gz: d214fe190c49d2acc66eeb6778d331926c3d517eb3aa5a007141cb464abeb522013f75cde9bae07a3b99a466ef34a39d0fc7380438c6f9ad70d6cbfcbfe8f044
+  metadata.gz: 98e0553379fa9a0b2105758cf271f7b7c0816a82d0116519e60f84aeadadc1ba8a25c8d4b53028f4fab5d0deaa1dc3a68da5a9efb01482a803b38ae6c59fc34d
+  data.tar.gz: b8f0873e672bbf51531ae4dbcee3948a11b4a16d52cd3c0f06adb50120e4e80186f864b97084cbb16864f9100fbf96e1f0e83908e600276323ca35e465a1b639

data/.gitignore

@@ -7,3 +7,4 @@
 /pkg/
 /spec/reports/
 /tmp/
+/.rubocop.todo.yml

data/.rubocop.yml

@@ -5,94 +5,39 @@ AllCops:
   StyleGuideCopsOnly: true
   TargetRubyVersion:  2.3
 
-Lint/HandleExceptions:
-  Exclude:
-    - spec/**/*_spec.rb
-
-Lint/RescueException:
-  Exclude:
-    - spec/**/*_spec.rb
-
-Metrics/LineLength:
-  Max: 80
-  Exclude:
-    - spec/**/*_spec.rb
-
-Style/AccessorMethodName:
-  Exclude:
-    - spec/**/*_spec.rb
-
 Style/Alias:
-  EnforcedStyle: prefer_alias_method
-
-Style/AsciiComments:
   Enabled: false
 
 Style/CaseEquality:
   Enabled: false
 
-Style/ClassAndModuleChildren:
-  Enabled: false
-
 Style/Documentation:
   Enabled: false
 
 Style/DoubleNegation:
   Enabled: false
 
-Style/EmptyLinesAroundClassBody:
-  Enabled: false
-
-Style/EmptyLinesAroundModuleBody:
-  Enabled: false
-
-Style/EmptyLineBetweenDefs:
-  Enabled: false
-
-Style/FileName:
+Style/LambdaCall:
   Enabled: false
 
-Style/Lambda:
-  Exclude:
-    - spec/**/*_spec.rb
-
-Style/LambdaCall:
+Style/MethodMissing:
   Enabled: false
 
-Style/ModuleFunction:
+Style/NumericPredicate:
   Enabled: false
 
 Style/RaiseArgs:
-  EnforcedStyle: compact
-
-Style/Semicolon:
-  Exclude:
-    - spec/**/*_spec.rb
-
-Style/SignalException:
-  EnforcedStyle: semantic
+  Enabled: false
 
-Style/SingleLineBlockParams:
+Style/RescueModifier:
   Enabled: false
 
 Style/SingleLineMethods:
   Exclude:
     - spec/**/*_spec.rb
 
-Style/SpaceBeforeFirstArg:
-  Enabled: false
-
-Style/SpecialGlobalVars:
-  Exclude:
-    - Gemfile
-    - dry-initializer.gemspec
-
 Style/StringLiterals:
   EnforcedStyle: double_quotes
 
 Style/StringLiteralsInInterpolation:
   EnforcedStyle: double_quotes
-
-Style/TrivialAccessors:
-  Exclude:
-    - spec/**/*_spec.rb

data/CHANGELOG.md

@@ -0,0 +1,50 @@
+# v0.3.0 2016-11-18
+
+This version changes the way of processing responses. Instead of dealing
+with raw rake responses, we add opinionated methods to gracefully process
+responses from JSON or plain text.
+
+In the next minor versions processors for both "form" and "file" (multipart)
+formats will be added.
+
+## BREAKING CHANGES
+- Method `DSL#response` was redefined with a new signature (nepalez)
+
+  The method takes 2 _mandatory_ positional params: unique name and
+  integer status. This allows to process responses with the same status,
+  and different structures, like in the following example, where errors
+  are returned with the same status 200 (not 4**) as success:
+
+  ```ruby
+  operation :update_user do
+    # ...
+    response :success, 200, model: User
+    response :error,   200, model: Error
+  end
+  ```
+
+  This time response handler will try processing a response using various
+  definitions (in order of their declaration) until some suits. The hanlder
+  returns `UnexpectedResponseError` in case no definition proves suitable.
+
+  Names (the first param) are unique. When several definitions use the same name,
+  only the last one will be applicable.
+
+## Added
+- Method `DSL#responses` to share options between response definitions (nepalez)
+
+  ```ruby
+  responses format: "json" do
+    responses raise: true do
+      response :failure,   400
+      response :not_found, 404
+    end
+  end
+  ```
+
+  This is the same as:
+
+  ```ruby
+  response :failure,   400, format: "json", raise: true
+  response :not_found, 404, format: "json", raise: true
+  ```

data/README.md

@@ -90,12 +90,21 @@ class CatsClient < Evil::Client
       attribute :age,   optional: true
     end
 
-    response 200 do |body:, **|
-      Cat.new JSON.parse(body) # define that the body should be wrapped to cat
+    # Parses json response and wraps it into Cat instance with additional
+    # parameter
+    response 200, format: :json, type: Cat do
+      attribute :success
     end
 
-    response 422, raise: true do |body:, **|
-      JSON.parse(body) # expect 422 to return json data
+    # Parses json response, wraps it into model with [#error] and raises
+    # an exception where [ResponseError#response] contains the model istance
+    response 422, format: :json, raise: true do
+      attribute :error
+    end
+
+    # Takes raw body and converts it into the hashie
+    response 404, raise: true do |body|
+      Hashie::Mash.new error: body
     end
   end
 

data/evil-client.gemspec

@@ -1,6 +1,6 @@
 Gem::Specification.new do |gem|
   gem.name     = "evil-client"
-  gem.version  = "0.2.3"
+  gem.version  = "0.3.0"
   gem.author   = "Andrew Kozin (nepalez)"
   gem.email    = "andrew.kozin@gmail.com"
   gem.homepage = "https://github.com/evilmartians/evil-client"

data/lib/evil/client.rb

@@ -41,7 +41,7 @@ require "rack"
 #         option :id, type: Dry::Types["coercible.int"].constrained(gt: 0)
 #       end
 #
-#       response 200, model: Cat
+#       response 200, type: Cat
 #       response 400, raise: true
 #       response 422, raise: true do |body:|
 #         JSON.parse(body.first)

data/lib/evil/client/connection.rb

@@ -12,11 +12,11 @@ class Evil::Client
     # @return [Class]
     #
     def self.[](name = nil)
-      key = (name || REGISTRY.keys.first).to_sym
-
+      keys  = REGISTRY.keys
+      key   = (name || keys.first).to_sym
       klass = REGISTRY.fetch(key) do
-        fail ArgumentError.new "Connection '#{key}' is not registered." \
-                               " Use the following keys: #{REGISTRY.keys}"
+        raise ArgumentError.new "Connection '#{key}' is not registered." \
+                                " Use the following keys: #{keys}"
       end
 
       require_relative "connection/#{key}"
@@ -29,7 +29,7 @@ class Evil::Client
     # @return [Array]
     #
     def call(_env)
-      fail NotImplementedError
+      raise NotImplementedError
     end
   end
 end

data/lib/evil/client/connection/net_http.rb

@@ -46,7 +46,7 @@ class Evil::Client
       end
 
       def build_uri(path, query)
-        base_uri.merge(path).tap { |uri| uri.query = query }
+        base_uri.merge(URI.encode(path)).tap { |uri| uri.query = query }
       end
 
       def handle(response)

data/lib/evil/client/dsl.rb

@@ -4,15 +4,6 @@ class Evil::Client
     require_relative "dsl/operations"
     require_relative "dsl/scope"
 
-    # Stack of default middleware before custom midleware and a connection
-    # This stack cannot be modified
-    DEFAULT_MIDDLEWARE = Middleware.new do
-      run Middleware::MergeSecurity
-      run Middleware::StringifyJson
-      run Middleware::StringifyQuery
-      run Middleware::NormalizeHeaders
-    end
-
     # Adds [#operations] to a specific client's instances
     def self.extended(klass)
       klass.include Dry::Initializer.define -> { param :operations }
@@ -106,7 +97,7 @@ class Evil::Client
 
     private
 
-    BASE_URL = -> (_) { fail NotImplementedError.new "Base url is not defined" }
+    BASE_URL = proc { raise NotImplementedError.new "Base url is not defined" }
 
     def schema
       @schema ||= {

data/lib/evil/client/dsl/operation.rb

@@ -1,6 +1,8 @@
 module Evil::Client::DSL
   require_relative "security"
   require_relative "files"
+  require_relative "response"
+  require_relative "responses"
 
   # Builds a schema for single operation
   class Operation
@@ -69,13 +71,12 @@ module Evil::Client::DSL
       @schema[:query] = __model__(options, &block)
     end
 
-    def response(*statuses, raise: false, &block)
-      statuses.each do |status|
-        @schema[:responses][status] = {
-          raise:   raise,
-          coercer: block || proc { |response:, **| response }
-        }
-      end
+    def responses(options = {}, &block)
+      Responses.new(self, options, &block)
+    end
+
+    def response(name, status, **options, &block)
+      @schema[:responses][name] = Response[status, block: block, **options]
     end
 
     # ==========================================================================
@@ -85,8 +86,8 @@ module Evil::Client::DSL
     def __valid_format__(format)
       formats = %w(json form)
       return format.to_s if formats.include? format.to_s
-      fail ArgumentError.new "Invalid format #{format} for body." \
-                             " Use one of formats: #{formats}"
+      raise ArgumentError.new "Invalid format #{format} for body." \
+                              " Use one of formats: #{formats}"
     end
 
     def __model__(model: nil, **, &block)

data/lib/evil/client/dsl/response.rb

@@ -0,0 +1,62 @@
+module Evil::Client::DSL
+  # Builds a schema for response processor
+  class Response
+    extend Dry::Initializer::Mixin
+    param  :status
+    option :raise,  default: proc { false }
+    option :format, default: proc {}
+    option :model,  default: proc { nil }
+    option :block,  default: proc { nil }
+
+    def self.[](*args)
+      new(*args).to_h
+    end
+
+    def to_h
+      { status: status.to_i, coercer: coercer, raise: raise }
+    end
+
+    private
+
+    def json?
+      format.to_s == "json"
+    end
+
+    def arity
+      block&.arity
+    end
+
+    def coercer
+      handlers = [parser, processor, wrapper, finalizer].compact
+      proc { |body| handlers.inject(body) { |obj, handler| handler.call(obj) } }
+    end
+
+    def parser
+      proc { |body| JSON.parse(body) } if json?
+    end
+
+    def wrapper
+      return unless json?
+      proc { |data| Hash === data ? data : { data: data } }
+    end
+
+    def processor
+      return unless block&.arity == 1
+      block
+    end
+
+    def addon
+      return unless arity == 0
+      proc { |klass| klass.instance_eval(&block) }
+    end
+
+    def finalizer
+      case [model.nil?, addon.nil?]
+      when [false, true]  then model
+      when [false, false] then Class.new(model).tap(&addon)
+      when [true,  false] then Class.new(Evil::Client::Model).tap(&addon)
+      else nil
+      end
+    end
+  end
+end

data/lib/evil/client/dsl/responses.rb

@@ -0,0 +1,29 @@
+class Evil::Client::DSL::Responses
+  # Add settings shared by several responses
+  #
+  # @param [#to_sym] name
+  # @param [#to_i]   status
+  # @param [Hash<Symbol, Object>] options
+  # @param [Proc] block
+  #
+  def response(name, status, **options, &block)
+    @client.send :response, name, status, @options.merge(options), &block
+  end
+
+  # Add settings shared by several responses
+  #
+  # @param [Hash<Symbol, Object>] options
+  # @param [Proc] block
+  #
+  def responses(**options, &block)
+    self.class.new(@client, @options.merge(options), &block)
+  end
+
+  private
+
+  def initialize(client, **options, &block)
+    @client  = client
+    @options = options
+    instance_eval(&block)
+  end
+end

data/lib/evil/client/dsl/scope.rb

@@ -2,7 +2,7 @@ module Evil::Client::DSL
   # Provides a namespace for client's top-level DSL
   class Scope
     extend Dry::Initializer::Mixin
-    option :__scope__, default: proc {}
+    option :__scope__, default: proc {}, reader: :private
 
     # Declares a method that opens new scope inside the current one
     # An instance of new scope has access to methods of its parent
@@ -20,14 +20,7 @@ module Evil::Client::DSL
 
     private
 
-    private :__scope__
-
-    def respond_to_missing?(name, *)
-      __scope__.respond_to? name
-    end
-
     def method_missing(name, *args)
-      super unless respond_to? name
       __scope__.send(name, *args)
     end
   end

data/lib/evil/client/dsl/security.rb

@@ -51,7 +51,7 @@ module Evil::Client::DSL
     def __validate__(part)
       parts = %i(body query headers)
       return if parts.include? part
-      fail ArgumentError.new("Wrong part '#{part}'. Use one of parts: #{parts}")
+      raise ArgumentError.new "Wrong part '#{part}'. Use one of parts: #{parts}"
     end
   end
 end

data/lib/evil/client/model.rb

@@ -25,8 +25,8 @@ class Evil::Client
         @attributes ||= []
       end
 
-      def option(name, type = nil, **opts)
-        super.tap { attributes << name.to_sym }
+      def option(name, type = nil, as: nil, **opts)
+        super.tap { attributes << (as || name).to_sym }
       end
       alias_method :attribute, :option
       alias_method :param, :option

data/lib/evil/client/operation/request.rb

@@ -13,8 +13,8 @@ class Evil::Client::Operation
     def build(options)
       {
         format:       schema[:format],
-        http_method:  http_method,
-        path:         path.call(options),
+        http_method:  extract(:method),
+        path:         extract(:path).call(options),
         security:     schema[:security]&.call(options),
         files:        schema[:files]&.call(options),
         query:        schema[:query]&.new(options).to_h,
@@ -29,14 +29,9 @@ class Evil::Client::Operation
       @key ||= schema[:key]
     end
 
-    def http_method
-      return schema[:method] if schema[:method]
-      fail NotImplementedError.new "No method defined for operation '#{key}'"
-    end
-
-    def path
-      return schema[:path] if schema[:path]
-      fail NotImplementedError.new "Path not defined for operation '#{key}'"
+    def extract(property)
+      return schema[property] if schema[property]
+      raise NotImplementedError, "No #{property} defined for operation '#{key}'"
     end
   end
 end

data/lib/evil/client/operation/response.rb

@@ -11,30 +11,29 @@ class Evil::Client::Operation
     #
     # @param  [Array] array Rack-compatible array of response data
     # @return [Object]
-    # @raise  [Evil::Client::ResponseError] if it is required by the schema
     #
-    def handle(array)
-      status, header, body = array
-      response = Rack::Response.new(body, status, header)
+    # @raise [Evil::Client::ResponseError] when needed by the schema
+    # @raise [Evil::Client::UnexpectedResponseError]
+    #   when a response cannot be processed
+    #
+    def handle(response)
+      status, _, body = response
+      body = body.any? ? body.join("\n") : nil
 
-      handler = response_schema(response)
-      data    = handler[:coercer].call response: response,
-                                       body:     response.body,
-                                       header:   response.header
+      handlers(status).each do |handler|
+        data = handler[:coercer][body] rescue next
+        raise ResponseError.new(schema, status, data) if handler[:raise]
+        return data
+      end
 
-      handler[:raise] ? fail(ResponseError.new(schema, status, data)) : data
+      raise UnexpectedResponseError.new(schema, status, body)
     end
 
     private
 
-    def name
-      @name ||= schema[:name]
-    end
-
-    def response_schema(response)
-      schema[:responses].fetch response.status do
-        fail UnexpectedResponseError.new(schema, response)
-      end
+    def handlers(status)
+      schema[:responses].values
+                        .select { |handler| handler[:status] == status }
     end
   end
 end

data/lib/evil/client/operation/response_error.rb

@@ -1,11 +1,12 @@
 class Evil::Client::Operation
   class ResponseError < RuntimeError
-    attr_reader :response
+    attr_reader :status, :data
 
     private
 
-    def initialize(schema, status, response)
-      @response = response
+    def initialize(schema, status, data)
+      @status = status
+      @data   = data
       super "Response to operation '#{schema[:key]}' has http status #{status}"
     end
   end

data/lib/evil/client/operation/unexpected_response_error.rb

@@ -1,15 +1,18 @@
 class Evil::Client::Operation
   class UnexpectedResponseError < RuntimeError
-    attr_reader :response
+    attr_reader :status, :data
 
     private
 
-    def initialize(schema, response)
-      @response = response
+    def initialize(schema, status, data)
+      @status = status
+      @data   = data
 
       message = "Response to operation '#{schema[:key]}'" \
-                " has unexpected http status #{response.status}."
+                " with http status #{status} and body #{data}" \
+                " cannot be processed."
       message << " See #{schema[:doc]} for details." if schema[:doc]
+
       super message
     end
   end

data/spec/features/middleware_spec.rb

@@ -34,9 +34,7 @@ RSpec.describe "middleware" do
       operation :find do
         path { "some" }
         http_method :post
-        response 200 do |body:, **|
-          body.first
-        end
+        response :success, 200, format: :plain
       end
     end
 

data/spec/features/operation_with_documentation_spec.rb

@@ -25,7 +25,7 @@ RSpec.describe "operation with documentation" do
     rescue => error
       expect(error.message).to include "https://docs.example.com/v3/index.html"
     else
-      fail
+      raise
     end
   end
 
@@ -35,7 +35,7 @@ RSpec.describe "operation with documentation" do
     rescue => error
       expect(error.message).to include "https://docs.example.com/v3/findData"
     else
-      fail
+      raise
     end
   end
 end

data/spec/features/operation_with_files_spec.rb

@@ -5,7 +5,7 @@ RSpec.describe "operation with files" do
       operation :example do
         http_method :get
         path { "users" }
-        response 200
+        response :success, 200
 
         files do |file:, **|
           add file, type: "text/xml", charset: "utf-16", filename: "foo.xml"

data/spec/features/operation_with_form_body_spec.rb

@@ -9,7 +9,7 @@ RSpec.describe "operation with form body" do
       operation do
         http_method :get
         path { "users" }
-        response 200
+        response :success, 200
       end
     end
 
@@ -26,7 +26,7 @@ RSpec.describe "operation with form body" do
         operation do
           http_method :get
           path { "users" }
-          response 200
+          response :success, 200
 
           body format: "form" do
             attribute :foo
@@ -57,7 +57,7 @@ RSpec.describe "operation with form body" do
         operation do
           http_method :get
           path { "users" }
-          response 200
+          response :success, 200
 
           body format: "form" do
             attribute :foo

data/spec/features/operation_with_headers_spec.rb

@@ -12,7 +12,7 @@ RSpec.describe "operation with headers" do
           attribute :baz, optional: true
         end
 
-        response 200
+        response :success, 200
       end
 
       operation :clear_data do

data/spec/features/operation_with_http_method_spec.rb

@@ -5,7 +5,7 @@ RSpec.describe "operation with http_method" do
       operation do |settings|
         http_method settings.version > 1 ? :post : :get
         path { "data" }
-        response 200
+        response :success, 200
       end
 
       operation :clear_data do

data/spec/features/operation_with_json_body_spec.rb

@@ -9,7 +9,7 @@ RSpec.describe "operation with json body" do
       operation do
         http_method :get
         path { "users" }
-        response 200
+        response :success, 200
       end
     end
 
@@ -26,7 +26,7 @@ RSpec.describe "operation with json body" do
         operation do
           http_method :get
           path { "users" }
-          response 200
+          response :success, 200
 
           body do
             attribute :foo
@@ -55,7 +55,7 @@ RSpec.describe "operation with json body" do
         operation do
           http_method :get
           path { "users" }
-          response 200
+          response :success, 200
 
           body do
             attribute :foo

data/spec/features/{operation_with_response_spec.rb → operation_with_nested_responses_spec.rb}

@@ -1,4 +1,4 @@
-RSpec.describe "operation with query" do
+RSpec.describe "operation with nested responses" do
   # see Test::Client definition in `/spec/support/test_client.rb`
   before do
     class Test::User < Evil::Client::Model
@@ -10,18 +10,22 @@ RSpec.describe "operation with query" do
         http_method :get
         path { "users" }
 
-        response 200
+        response :success, 200, format: :plain
       end
 
       operation :example do
-        response 201 do |body:, header:, response:|
-          [body, header, response]
-        end
-
-        response 404, raise: true
-
-        response 422, raise: true do |body:, header:, response:|
-          [body, header, response]
+        responses format: :plain do
+          response :created, 201 do |body|
+            body.to_sym
+          end
+
+          responses raise: true do
+            response :not_found, 404
+
+            response :error, 422 do |body|
+              body.to_sym
+            end
+          end
         end
       end
     end
@@ -36,9 +40,7 @@ RSpec.describe "operation with query" do
                                      headers: { "Foo" => "BAR" },
                                      body: "Hi!"
 
-    expect(subject).to be_kind_of Rack::Response
-    expect(subject.headers).to include "foo" => ["BAR"]
-    expect(subject.body).to eq ["Hi!"]
+    expect(subject).to eq "Hi!"
   end
 
   it "applies block to coerce data" do
@@ -46,13 +48,7 @@ RSpec.describe "operation with query" do
                                      headers: { "Foo" => "BAR" },
                                      body: "Hi!"
 
-    body, headers, response = subject
-
-    expect(response.headers).to include "foo" => ["BAR"]
-    expect(response.body).to eq ["Hi!"]
-
-    expect(body).to eq response.body
-    expect(headers).to eq response.headers
+    expect(subject).to eq :Hi!
   end
 
   it "raises ResponseError when necessary" do
@@ -63,11 +59,9 @@ RSpec.describe "operation with query" do
     begin
       subject
     rescue Evil::Client::Operation::ResponseError => error
-      expect(error.response).to be_kind_of Rack::Response
-      expect(error.response.headers).to include "foo" => ["BAR"]
-      expect(error.response.body).to eq ["Hi!"]
+      expect(error.data).to eq "Hi!"
     else
-      fail
+      raise
     end
   end
 
@@ -79,15 +73,9 @@ RSpec.describe "operation with query" do
     begin
       subject
     rescue Evil::Client::Operation::ResponseError => error
-      body, headers, response = error.response
-
-      expect(response.headers).to include "foo" => ["BAR"]
-      expect(response.body).to eq ["Hi!"]
-
-      expect(body).to eq response.body
-      expect(headers).to eq response.headers
+      expect(error.data).to eq :Hi!
     else
-      fail
+      raise
     end
   end
 
@@ -99,11 +87,9 @@ RSpec.describe "operation with query" do
     begin
       subject
     rescue Evil::Client::Operation::UnexpectedResponseError => error
-      expect(error.response).to be_kind_of Rack::Response
-      expect(error.response.headers).to include "foo" => ["BAR"]
-      expect(error.response.body).to eq ["Hi!"]
+      expect(error.data).to eq "Hi!"
     else
-      fail
+      raise
     end
   end
 end

data/spec/features/operation_with_path_spec.rb

@@ -5,7 +5,7 @@ RSpec.describe "operation with path" do
       operation do
         http_method :get
         path { "users" }
-        response 200
+        response :success, 200
       end
 
       operation :find_users

data/spec/features/operation_with_query_spec.rb

@@ -9,7 +9,7 @@ RSpec.describe "operation with query" do
       operation do
         http_method :get
         path { "users" }
-        response 200
+        response :success, 200
       end
 
       operation :filter do

data/spec/features/operation_with_security_spec.rb

@@ -5,7 +5,7 @@ RSpec.describe "operation with security" do
       operation do
         http_method :get
         path { "data" }
-        response 200
+        response :success, 200
       end
     end
 
@@ -29,7 +29,7 @@ RSpec.describe "operation with security" do
         operation do |settings|
           http_method :get
           path { "data" }
-          response 200
+          response :success, 200
 
           security do
             basic_auth settings.user, settings.password

data/spec/features/scoping_spec.rb

@@ -14,7 +14,7 @@ RSpec.describe "scoping" do
           attribute :name
         end
 
-        response 200
+        response :success, 200
       end
 
       scope do

data/spec/unit/evil/client/dsl/operation_spec.rb

@@ -204,30 +204,171 @@ RSpec.describe Evil::Client::DSL::Operation do
   end
 
   context "with #response" do
-    let(:block) do
-      proc do |_|
-        response 200 do |value|
-          value.to_sym
+    let(:response_schema)  { subject[:responses][:success] }
+    let(:response_raise)   { response_schema[:raise] }
+    let(:response_coercer) { response_schema[:coercer] }
+
+    context "with plain format" do
+      let(:body)  { "foo" }
+      let(:block) { proc { |_| response :success, 200, format: :plain } }
+
+      it "works" do
+        expect(response_coercer.call(body)).to eq "foo"
+      end
+    end
+
+    context "with plain format and handler" do
+      let(:body) { "foo" }
+      let(:block) do
+        proc do |_|
+          response :success, 200, format: :plain do |body|
+            body.to_sym
+          end
+        end
+      end
+
+      it "applies coercer" do
+        expect(response_coercer.call(body)).to eq :foo
+      end
+    end
+
+    context "with plain format and type" do
+      let(:body) { "0" }
+      let(:block) do
+        proc do |_|
+          response :success,
+                   200,
+                   format: :plain,
+                   model: Dry::Types["coercible.int"]
+        end
+      end
+
+      it "uses type" do
+        expect(response_coercer.call(body)).to eq 0
+      end
+    end
+
+    context "with plain format, coercer and type" do
+      let(:body) { "0" }
+      let(:block) do
+        proc do |_|
+          response :success,
+                   200,
+                   format: :plain,
+                   model: Dry::Types["coercible.string"] { |val| val.to_i + 1 }
+        end
+      end
+
+      it "applies coercer and then type" do
+        expect(response_coercer.call(body)).to eq "1"
+      end
+    end
+
+    context "with json format" do
+      let(:body) { '{"foo":1,"baz":"qux"}' }
+      let(:block) { proc { |_| response :success, 200, format: :json } }
+
+      it "returns parsed body" do
+        expect(response_coercer.call(body)).to eq "foo" => 1, "baz" => "qux"
+      end
+    end
+
+    context "with json format and handler" do
+      let(:body) { '{"foo":1,"baz":"qux"}' }
+      let(:block) do
+        proc do |_|
+          response :success, 200, format: :json do |body|
+            body.keys
+          end
+        end
+      end
+
+      it "returns parsed and handled body" do
+        expect(response_coercer.call(body)).to eq data: %w(foo baz)
+      end
+    end
+
+    context "with json format and type" do
+      before do
+        class Test::Foo < Evil::Client::Model
+          attribute :foo
+        end
+      end
+
+      let(:body) { '{"foo":1,"baz":"qux"}' }
+      let(:block) do
+        proc do |_|
+          response :success, 200, format: :json, model: Test::Foo
+        end
+      end
+
+      it "returns parsed and filtered body" do
+        expect(response_coercer.call(body)).to eq foo: 1
+      end
+    end
+
+    context "with json format, type and handler" do
+      before do
+        class Test::Foo < Evil::Client::Model
+          attribute :foo
+        end
+      end
+
+      let(:body) { '{"foo":1,"baz":"qux"}' }
+      let(:block) do
+        proc do |_|
+          response :success, 200, format: :json, model: Test::Foo do |body|
+            body["foo"] = body["foo"].to_s
+            body
+          end
+        end
+      end
+
+      it "returns parsed, handled and filtered body" do
+        expect(response_coercer.call(body)).to eq Test::Foo.new(foo: "1")
+      end
+    end
+
+    context "with json format and filter" do
+      before do
+        class Test::Foo < Evil::Client::Model
+          attribute :foo
         end
+      end
 
-        response 404, raise: true do |value|
-          value.to_s
+      let(:body) { '{"foo":1,"baz":"qux"}' }
+      let(:block) do
+        proc do |_|
+          response :success, 200, format: :json do
+            attribute :baz
+          end
         end
+      end
 
-        response 500, raise: true
+      it "returns parsed and filtered body" do
+        expect(response_coercer.call(body)).to eq baz: "qux"
       end
     end
 
-    it "defines :responses" do
-      responses = subject[:responses]
+    context "with json format, type and filter" do
+      before do
+        class Test::Foo < Evil::Client::Model
+          attribute :foo
+        end
+      end
 
-      expect(responses[200]).to include raise: false
-      expect(responses[404]).to include raise: true
-      expect(responses[500]).to include raise: true
+      let(:body) { '{"foo":1,"baz":2}' }
+      let(:block) do
+        proc do |_|
+          response :success, 200, format: :json, model: Test::Foo do
+            attribute :baz, Dry::Types["coercible.string"]
+          end
+        end
+      end
 
-      expect(responses[200][:coercer]["foo"]).to eq :foo
-      expect(responses[404][:coercer][:foo]).to eq "foo"
-      expect(responses[500][:coercer][response: :foo]).to eq :foo
+      it "returns parsed and filtered body" do
+        expect(response_coercer.call(body)).to eq foo: 1, baz: "2"
+      end
     end
   end
 end

data/spec/unit/evil/client/dsl/operations_spec.rb

@@ -1,6 +1,8 @@
 describe Evil::Client::DSL::Operations do
   let(:operations) { described_class.new }
-  let(:settings)   { double(:settings, version: 1, user: "foo", password: "bar") }
+  let(:settings) do
+    double(:settings, version: 1, user: "foo", password: "bar")
+  end
 
   before do
     operations.register(nil) do |settings|

data/spec/unit/evil/client/dsl/security_spec.rb

@@ -52,7 +52,7 @@ RSpec.describe Evil::Client::DSL::Security do
       end
     end
 
-    it "fails" do
+    it "raises" do
       expect { subject }.to raise_error ArgumentError
     end
   end

data/spec/unit/evil/client/operation/response_spec.rb

@@ -5,12 +5,14 @@ RSpec.describe Evil::Client::Operation::Response do
       key: :find_user,
       doc: "http://example.com/users",
       responses: {
-        200 => {
-          coercer: proc { |body:, **| body.first.upcase.to_sym },
+        success: {
+          status:  200,
+          coercer: proc { |body| body.upcase.to_sym },
           raise:   false
         },
-        400 => {
-          coercer: proc { |body:, **| body.first.upcase.to_sym },
+        error: {
+          status:  400,
+          coercer: proc { |body| body.upcase.to_sym },
           raise:   true
         }
       }
@@ -35,9 +37,9 @@ RSpec.describe Evil::Client::Operation::Response do
         subject
       rescue Evil::Client::Operation::ResponseError => error
         expect(error.message).to include "find_user"
-        expect(error.response).to eq :FOO
+        expect(error.data).to eq :FOO
       else
-        fail
+        raise
       end
     end
   end
@@ -51,10 +53,10 @@ RSpec.describe Evil::Client::Operation::Response do
       rescue Evil::Client::Operation::UnexpectedResponseError => error
         expect(error.message).to include "find_user"
         expect(error.message).to include "http://example.com/users"
-        expect(error.response).to be_a Rack::Response
-        expect(error.response.status).to eq 404
+        expect(error.data).to eq "foo"
+        expect(error.status).to eq 404
       else
-        fail
+        raise
       end
     end
   end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: evil-client
 version: !ruby/object:Gem::Version
-  version: 0.2.3
+  version: 0.3.0
 platform: ruby
 authors:
 - Andrew Kozin (nepalez)
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-11-07 00:00:00.000000000 Z
+date: 2016-11-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: dry-initializer
@@ -128,12 +128,14 @@ executables: []
 extensions: []
 extra_rdoc_files:
 - README.md
+- CHANGELOG.md
 files:
 - ".codeclimate.yml"
 - ".gitignore"
 - ".rspec"
 - ".rubocop.yml"
 - ".travis.yml"
+- CHANGELOG.md
 - Gemfile
 - LICENSE.txt
 - README.md
@@ -160,6 +162,8 @@ files:
 - lib/evil/client/dsl/files.rb
 - lib/evil/client/dsl/operation.rb
 - lib/evil/client/dsl/operations.rb
+- lib/evil/client/dsl/response.rb
+- lib/evil/client/dsl/responses.rb
 - lib/evil/client/dsl/scope.rb
 - lib/evil/client/dsl/security.rb
 - lib/evil/client/middleware.rb
@@ -186,9 +190,9 @@ files:
 - spec/features/operation_with_headers_spec.rb
 - spec/features/operation_with_http_method_spec.rb
 - spec/features/operation_with_json_body_spec.rb
+- spec/features/operation_with_nested_responses_spec.rb
 - spec/features/operation_with_path_spec.rb
 - spec/features/operation_with_query_spec.rb
-- spec/features/operation_with_response_spec.rb
 - spec/features/operation_with_security_spec.rb
 - spec/features/scoping_spec.rb
 - spec/spec_helper.rb
@@ -243,9 +247,9 @@ test_files:
 - spec/features/operation_with_headers_spec.rb
 - spec/features/operation_with_http_method_spec.rb
 - spec/features/operation_with_json_body_spec.rb
+- spec/features/operation_with_nested_responses_spec.rb
 - spec/features/operation_with_path_spec.rb
 - spec/features/operation_with_query_spec.rb
-- spec/features/operation_with_response_spec.rb
 - spec/features/operation_with_security_spec.rb
 - spec/features/scoping_spec.rb
 - spec/spec_helper.rb