evil-client 0.3.1 → 0.3.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 1993a11c6b8086dec9802e02c4beeb56e8aadef3
-  data.tar.gz: 273f6c22939793760abc5bbae79681c03490116b
+  metadata.gz: 792691363738b2a89d8579cfcdd33e95fcf496bd
+  data.tar.gz: 5477063a34c23b048748d2a47d9f256f17a9a025
 SHA512:
-  metadata.gz: 2d639bf5c2a2e8e1362df945d6416cc012052ea653ee8103eaeb7548c9e733aeaa400e3d7fa3c6eafee617a496c6edcfc581e22eb2dca31f003c175c716cca1b
-  data.tar.gz: 07011a575fdbbe193f280fe2cc68c0556547092b752fa617f5d40e1524bb26ee30b207efe4d98f217e1a38997772c8889cc5014ff026be35122e89338e822507
+  metadata.gz: 586b7861e76d8e6f56bdd8f1668cad0e25ba75fd4247dd4e5e810ece64999e882b555b039a194c5c97d80280c46cd49d71ae78d23c83ba87758f59574a762008
+  data.tar.gz: 5eaada81c8761c9c4bbe40a9be0fc4bb1006b6fea7501a8cd3162ccab6229f03f20c4b7dde6aaff4dc073406be7582ff33c3f6d75219dd110d02d5746fa66038

data/.rubocop.yml

@@ -5,16 +5,16 @@ AllCops:
   StyleGuideCopsOnly: true
   TargetRubyVersion:  2.3
 
-Style/Alias:
+Style/CaseEquality:
+  Enabled: false
+
+Style/Documentation:
   Enabled: false
 
 Style/FileName:
   Exclude:
     - lib/evil-client.rb
 
-Style/Documentation:
-  Enabled: false
-
 Style/LambdaCall:
   Enabled: false
 
@@ -34,19 +34,5 @@ Style/RaiseArgs:
 Style/RescueModifier:
   Enabled: false
 
-Style/SingleLineBlockParams:
-  Enabled: false
-
-Style/SingleLineMethods:
-  Exclude:
-    - spec/**.rb
-
 Style/StringLiterals:
   EnforcedStyle: double_quotes
-
-Style/StringLiteralsInInterpolation:
-  EnforcedStyle: double_quotes
-
-Style/SymbolProc:
-  Exclude:
-    - spec/**.rb

data/CHANGELOG.md

@@ -1,4 +1,19 @@
-# v0.3.1 2016-11-20
+# v0.3.2 2016-11-29
+
+On the road to v0.4.0
+
+## Fixed
+- Query and body encoding (nepalez)
+
+## Internal
+- Refactoring of some DSL classes (nepalez)
+
+[Compare v0.3.1...v0.3.2](https://github.com/dry-rb/dry-initializer/compare/v0.3.1...v0.3.2)
+
+# v0.3.1 2016-11-22
+
+## Fixed
+- Loading of 'json' from stdlib (nepalez)
 
 ## Internal
 - Class `Evil::Client::Model` is extracted to `evil-struct` gem (nepalez)

data/README.md

@@ -20,8 +20,8 @@ The gem stands away from mutable states and monkey patching when possible. To su
 For now the DSL supports clients to **json** and **form data** APIs out of the box. Because of high variance of XML-based APIs, building corresponding clients require more efforts on a middleware level.
 
 [swagger]: http://swagger.io
-[dry-initializer]: http://dry-rb.org/gems./dry-initializer
-[dry-types]: http://dry-rb.org/gems./dry-types
+[dry-initializer]: http://dry-rb.org/gems/dry-initializer
+[dry-types]: http://dry-rb.org/gems/dry-types
 
 ## Installation
 
@@ -52,20 +52,20 @@ require "evil-client"
 require "dry-types"
 
 class CatsClient < Evil::Client
-  # describe a client-specific model of cat (the furry pinnacle of evolution)
+  # Prepare client-specific model of cat (the furry pinnacle of evolution)
   class Cat < Evil::Struct
-    attribute :name,  type: Dry::Types["strict.string"], optional: true
-    attribute :color, type: Dry::Types["strict.string"]
-    attribute :age,   type: Dry::Types["coercible.int"], default: proc { 0 }
+    attribute :name,  Dry::Types["strict.string"], optional: true
+    attribute :color, Dry::Types["strict.string"]
+    attribute :age,   Dry::Types["coercible.int"], default: proc { 0 }
   end
 
   # Define settings the client initialized with
   # The settings parameterizes operations when necessary
   settings do
-    param  :domain,   type: Dry::Types["strict.string"] # required!
-    option :version,  type: Dry::Types["coercible.int"], default: proc { 0 }
-    option :user,     type: Dry::Types["strict.string"] # required!
-    option :password, type: Dry::Types["strict.string"] # required!
+    param  :domain,   Dry::Types["strict.string"] # required!
+    option :version,  Dry::Types["coercible.int"], default: proc { 0 }
+    option :user,     Dry::Types["strict.string"] # required!
+    option :password, Dry::Types["strict.string"] # required!
   end
 
   # Define a base url using
@@ -85,15 +85,17 @@ class CatsClient < Evil::Client
     path { |id:, **| "cats/#{id}" } # id will be taken from request parameters
 
     body format: "json" do
-      attribute :name,  optional: true
-      attribute :color, optional: true
-      attribute :age,   optional: true
+      attributes optional: true do
+        attribute :name
+        attribute :color
+        attribute :age
+      end
     end
 
     # Parses json response and wraps it into Cat instance with additional
     # parameter
-    response 200, format: :json, type: Cat do
-      attribute :success
+    response 200, format: :json, model: Cat do
+      attribute :success # add response-specific attribute to the cat
     end
 
     # Parses json response, wraps it into model with [#error] and raises

data/evil-client.gemspec

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

data/lib/evil/client/connection.rb

@@ -24,11 +24,7 @@ class Evil::Client
     end
 
     # @abstract Sends request to the server and returns rack-compatible response
-    #
-    # @param  [Hash] env
-    # @return [Array]
-    #
-    def call(_env)
+    def call(_env, *)
       raise NotImplementedError
     end
   end

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

@@ -12,7 +12,7 @@ class Evil::Client
       #   :http_method, :path, :query_string, :body_string, :headers
       # @return [Array] Rack-compatible response [status, body, headers]
       #
-      def call(env)
+      def call(env, *)
         request = build_request(env)
         Net::HTTP.start base_uri.host, base_uri.port, opts do |http|
           handle http.request(request)

data/lib/evil/client/dsl.rb

@@ -1,6 +1,17 @@
 class Evil::Client
   # Defines a DSL to customize class-level settings of the specific client
   module DSL
+    require_relative "dsl/base"
+    require_relative "dsl/files"
+    require_relative "dsl/headers"
+    require_relative "dsl/http_method"
+    require_relative "dsl/path"
+    require_relative "dsl/query"
+    require_relative "dsl/response"
+    require_relative "dsl/responses"
+    require_relative "dsl/security"
+    require_relative "dsl/verifier"
+    require_relative "dsl/operation"
     require_relative "dsl/operations"
     require_relative "dsl/scope"
 

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

@@ -0,0 +1,26 @@
+module Evil::Client::DSL
+  class Base
+    def self.[](schema, *args, &block)
+      new(*args, &block).call(schema)
+    end
+
+    def call(schema)
+      schema
+    end
+
+    private
+
+    def merge(source, target)
+      target.inject(source) do |obj, (key, val)|
+        obj.merge key => (Hash === val ? merge(obj.fetch(key, {}), val) : val)
+      end
+    end
+
+    def coercer
+      @coercer ||= if    @model && @block then Class.new(@model, &@block)
+                   elsif @block           then Class.new(Evil::Struct, &@block)
+                   elsif @model           then @model
+                   end
+    end
+  end
+end

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

@@ -0,0 +1,16 @@
+module Evil::Client::DSL
+  class Headers < Base
+    def call(schema)
+      merge schema, headers: coercer
+    end
+
+    private
+
+    attr_reader :model, :block
+
+    def initialize(model: Evil::Struct, &block)
+      @model = model
+      @block = block
+    end
+  end
+end

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

@@ -0,0 +1,24 @@
+module Evil::Client::DSL
+  class HttpMethod < Base
+    def call(schema)
+      merge schema, method: http_method
+    end
+
+    private
+
+    attr_reader :block, :string
+
+    def initialize(string = nil, &block)
+      @string = string.to_s.downcase
+      @block  = block
+    end
+
+    def http_method
+      if block
+        ->(opts) { block.call(opts).to_s.downcase }
+      else
+        proc { string }
+      end
+    end
+  end
+end

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

@@ -1,19 +1,7 @@
 module Evil::Client::DSL
-  require_relative "security"
-  require_relative "files"
-  require_relative "response"
-  require_relative "responses"
-
-  # Builds a schema for single operation
   class Operation
     attr_reader :schema
 
-    # Builds a schema for a single operation
-    #
-    # @param  [Object] settings
-    # @param  [Proc] block A block of definitions (should accept settings)
-    # @return [Hash<Symbol, Object>]
-    #
     def finalize(settings)
       @mutex.synchronize do
         @schema = @default.dup
@@ -39,12 +27,12 @@ module Evil::Client::DSL
       @schema[:doc] = value
     end
 
-    def http_method(value)
-      @schema[:method] = value.to_s.downcase
+    def http_method(value = nil, &block)
+      @schema = HttpMethod[schema, value, &block]
     end
 
-    def path
-      @schema[:path] = ->(**opts) { yield(opts).gsub(%r{\A/+|/+\z}, "") }
+    def path(value = nil, &block)
+      @schema = Path[schema, value, &block]
     end
 
     def security(&block)
@@ -63,12 +51,12 @@ module Evil::Client::DSL
       @schema.delete :files
     end
 
-    def headers(**options, &block)
-      @schema[:headers] = __model__(options, &block)
+    def headers(model: Evil::Struct, &block)
+      @schema = Headers[schema, model: model, &block]
     end
 
-    def query(**options, &block)
-      @schema[:query] = __model__(options, &block)
+    def query(model: Evil::Struct, &block)
+      @schema = Query[schema, model: model, &block]
     end
 
     def responses(options = {}, &block)

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

@@ -1,6 +1,4 @@
 module Evil::Client::DSL
-  require_relative "operation"
-
   # Container for operations definitions
   # Applies settings to definitions and returns a final schema
   class Operations
@@ -24,12 +22,14 @@ module Evil::Client::DSL
       default = @schema[nil].finalize(settings)
       custom  = @schema.select { |key| key }
 
-      custom.each_with_object({}) do |(key, operation), hash|
+      schema = custom.each_with_object({}) do |(key, operation), hash|
         custom = operation.finalize(settings)
         hash[key] = default.merge(custom)
         hash[key][:format] ||= "json"
         hash[key][:responses] = default[:responses].merge(custom[:responses])
       end
+
+      Verifier.call(schema)
     end
 
     private

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

@@ -0,0 +1,25 @@
+module Evil::Client::DSL
+  # Adds path settings to the operation's schema
+  class Path < Base
+    def call(schema)
+      merge schema, path: path
+    end
+
+    private
+
+    SLASHES = %r{\A/+|/+\z}
+
+    attr_reader :block, :value
+
+    def initialize(value = nil, &block)
+      @value = value.to_s.gsub(SLASHES, "")
+      @block = block
+    end
+
+    def path
+      if block then ->(opts) { block.call(opts).to_s.gsub(SLASHES, "") }
+      else          ->(_) { value }
+      end
+    end
+  end
+end

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

@@ -0,0 +1,16 @@
+module Evil::Client::DSL
+  class Query < Base
+    def call(schema)
+      merge schema, query: coercer
+    end
+
+    private
+
+    attr_reader :model, :block
+
+    def initialize(model: nil, &block)
+      @model = model
+      @block = block
+    end
+  end
+end

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

@@ -0,0 +1,35 @@
+module Evil::Client::DSL
+  SchemaError = Class.new(StandardError)
+
+  # Verifies a final schema
+  class Verifier
+    def self.call(schema)
+      new(schema).call
+    end
+
+    def call
+      @schema.each do |key, schema|
+        check_path(key, schema)
+        check_method(key, schema)
+      end
+    end
+
+    private
+
+    def initialize(schema)
+      @schema = schema
+    end
+
+    def check_path(key, schema)
+      return if schema[:path]
+      raise SchemaError,
+            "Path definition is missed for operation :#{key}"
+    end
+
+    def check_method(key, schema)
+      return if schema[:method]
+      raise SchemaError,
+            "HTTP method definition is missed for operation :#{key}"
+    end
+  end
+end

data/lib/evil/client/middleware/base.rb

@@ -1,6 +1,6 @@
 class Evil::Client::Middleware::Base
-  def call(env)
-    @app.call build(env)
+  def call(env, schema, options)
+    @app.call(env, schema, options)
   end
 
   private
@@ -8,8 +8,4 @@ class Evil::Client::Middleware::Base
   def initialize(app)
     @app = app
   end
-
-  def build(env)
-    env
-  end
 end

data/lib/evil/client/middleware/merge_security.rb

@@ -1,5 +1,9 @@
 class Evil::Client::Middleware
   class MergeSecurity < Base
+    def call(env, schema, options)
+      super build(env), schema, options
+    end
+
     private
 
     def build(env)

data/lib/evil/client/middleware/normalize_headers.rb

@@ -1,5 +1,9 @@
 class Evil::Client::Middleware
   class NormalizeHeaders < Base
+    def call(env, schema, options)
+      super build(env), schema, options
+    end
+
     private
 
     def build(env)

data/lib/evil/client/middleware/stringify_form.rb

@@ -1,5 +1,9 @@
 class Evil::Client::Middleware
   class StringifyForm < Base
+    def call(env, schema, options)
+      super build(env), schema, options
+    end
+
     private
 
     def build(env)

data/lib/evil/client/middleware/stringify_json.rb

@@ -1,5 +1,9 @@
 class Evil::Client::Middleware
   class StringifyJson < Base
+    def call(env, schema, options)
+      super build(env), schema, options
+    end
+
     private
 
     def build(env)

data/lib/evil/client/middleware/stringify_multipart.rb

@@ -2,6 +2,10 @@ class Evil::Client::Middleware
   class StringifyMultipart < Base
     require_relative "stringify_multipart/part"
 
+    def call(env, schema, options)
+      super build(env), schema, options
+    end
+
     private
 
     def build(env)

data/lib/evil/client/middleware/stringify_query.rb

@@ -1,5 +1,9 @@
 class Evil::Client::Middleware
   class StringifyQuery < Base
+    def call(env, schema, options)
+      super build(env), schema, options
+    end
+
     private
 
     def build(env)

data/lib/evil/client/operation.rb

@@ -16,8 +16,8 @@ class Evil::Client
     # @return [Object]
     #
     def call(**options)
-      req   = request.build(options)
-      array = connection.call(req)
+      env   = request.build(options)
+      array = connection.call(env, schema, options)
       response.handle(array)
     end
 

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

@@ -12,26 +12,15 @@ class Evil::Client::Operation
     #
     def build(options)
       {
-        format:       schema[:format],
-        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,
-        body:         schema[:body]&.new(options).to_h,
-        headers:      schema[:headers]&.new(options).to_h
+        format:      schema[:format],
+        http_method: schema[:method].call(options),
+        path:        schema[:path].call(options),
+        security:    schema[:security]&.call(options),
+        files:       schema[:files]&.call(options),
+        query:       schema[:query]&.new(options).to_h,
+        body:        schema[:body]&.new(options).to_h,
+        headers:     schema[:headers]&.new(options).to_h
       }
     end
-
-    private
-
-    def key
-      @key ||= schema[:key]
-    end
-
-    def extract(property)
-      return schema[property] if schema[property]
-      raise NotImplementedError, "No #{property} defined for operation '#{key}'"
-    end
   end
 end

data/spec/features/middleware_spec.rb

@@ -5,13 +5,17 @@ RSpec.describe "middleware" do
         @app = app
       end
 
-      def call(_env)
-        @app.call path: "data/1",
-                  http_method: "get",
-                  format: "form",
-                  headers: { "baz" => "BAZ" },
-                  query: { "bar" => "baz" },
-                  body: { "qux" => 2 }
+      def call(_env, schema, options)
+        env = {
+          path: "data/1",
+          http_method: "get",
+          format: "form",
+          headers: { "baz" => "BAZ" },
+          query: { "bar" => "baz" },
+          body: { "qux" => 2 }
+        }
+
+        @app.call env, schema, options
       end
     end
 
@@ -20,8 +24,10 @@ RSpec.describe "middleware" do
         @app = app
       end
 
-      def call(env)
-        @app.call(env).tap { |rack_response| rack_response[2] = ["Hi!"] }
+      def call(env, *params)
+        response = @app.call(env, *params)
+        response[2] = ["Hi!"]
+        response
       end
     end
 

data/spec/features/operation_with_path_spec.rb

@@ -4,8 +4,8 @@ RSpec.describe "operation with path" do
     class Test::Client < Evil::Client
       operation do
         http_method :get
-        path { "users" }
-        response :success, 200
+        path        "users"
+        response    :success, 200
       end
 
       operation :find_users
@@ -15,7 +15,7 @@ RSpec.describe "operation with path" do
       end
 
       operation :login do |settings|
-        path { "login/#{settings.token}" }
+        path "login/#{settings.token}"
       end
     end
 

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

@@ -27,7 +27,7 @@ RSpec.describe Evil::Client::DSL::Operation do
     end
 
     it "defines :method" do
-      expect(subject[:method]).to eq "post"
+      expect(subject[:method].call).to eq "post"
     end
   end
 

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

@@ -21,7 +21,7 @@ describe Evil::Client::DSL::Operations do
   it "builds a proper schema" do
     find_user = subject[:find_user]
 
-    expect(find_user[:method]).to eq "get"
+    expect(find_user[:method].call).to eq "get"
     expect(find_user[:path].call(id: 7)).to eq "users/7"
     expect(find_user[:security].call)
       .to eq headers: { "authorization" => "Basic Zm9vOmJhcg==" }

data/spec/unit/evil/client/middleware/merge_security_spec.rb

@@ -6,8 +6,8 @@ RSpec.describe Evil::Client::Middleware::MergeSecurity do
     @result = env
   end
 
-  before  { allow(app).to receive(:call) { |env| update! env } }
-  subject { stack.call env }
+  before  { allow(app).to receive(:call) { |env, *| update! env } }
+  subject { stack.call env, {}, {} }
 
   let(:env) do
     {

data/spec/unit/evil/client/middleware/normalize_headers_spec.rb

@@ -7,8 +7,8 @@ RSpec.describe Evil::Client::Middleware::NormalizeHeaders do
     @result = env
   end
 
-  before  { allow(app).to receive(:call) { |env| update! env } }
-  subject { stack.call env }
+  before  { allow(app).to receive(:call) { |env, *| update! env } }
+  subject { stack.call env, {}, {} }
 
   it "normalizes headers" do
     subject

data/spec/unit/evil/client/middleware/stringify_form_spec.rb

@@ -6,8 +6,8 @@ RSpec.describe Evil::Client::Middleware::StringifyForm do
     @result = env
   end
 
-  before  { allow(app).to receive(:call) { |env| update! env } }
-  subject { stack.call env }
+  before  { allow(app).to receive(:call) { |env, *| update! env } }
+  subject { stack.call env, {}, {} }
 
   context "with a non-empty body:" do
     let(:env) do

data/spec/unit/evil/client/middleware/stringify_json_spec.rb

@@ -5,8 +5,8 @@ RSpec.describe Evil::Client::Middleware::StringifyJson do
 
   let(:app) { double :app }
 
-  before  { allow(app).to receive(:call) { |env| update!(env) } }
-  subject { described_class.new(app).call(env) }
+  before  { allow(app).to receive(:call) { |env, *| update!(env) } }
+  subject { described_class.new(app).call(env, {}, {}) }
 
   context "with a body:" do
     let(:env) { { format: "json", body: { foo: :bar } } }

data/spec/unit/evil/client/middleware/stringify_multipart_spec.rb

@@ -20,8 +20,8 @@ RSpec.describe Evil::Client::Middleware::StringifyMultipart do
     @result = result
   end
 
-  before  { allow(app).to receive(:call) { |env| update!(env) } }
-  subject { described_class.new(app).call(env) }
+  before  { allow(app).to receive(:call) { |env, *| update!(env) } }
+  subject { described_class.new(app).call(env, {}, {}) }
 
   context "with a multipart format:" do
     let(:body_string) { @result[:body_string] }

data/spec/unit/evil/client/middleware/stringify_query_spec.rb

@@ -7,7 +7,7 @@ RSpec.describe Evil::Client::Middleware::StringifyQuery do
   end
 
   before  { allow(app).to receive(:call) { |env| update! env } }
-  subject { stack.call env }
+  subject { stack.call env, {}, {} }
 
   context "with a non-empty query:" do
     let(:env) do

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

@@ -18,7 +18,7 @@ RSpec.describe Evil::Client::Operation::Request do
   let(:schema) do
     {
       format:   "multipart",
-      method:   "patch",
+      method:   proc { "patch" },
       path:     proc { |id:, **| "users/#{id}" },
       files:    Evil::Client::DSL::Files.new { |file:, **| add file },
       security: Evil::Client::DSL::Security.new { basic_auth "qux", "abc" },

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: evil-client
 version: !ruby/object:Gem::Version
-  version: 0.3.1
+  version: 0.3.2
 platform: ruby
 authors:
 - Andrew Kozin (nepalez)
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-11-20 00:00:00.000000000 Z
+date: 2016-11-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: evil-struct
@@ -167,13 +167,19 @@ files:
 - lib/evil/client/connection.rb
 - lib/evil/client/connection/net_http.rb
 - lib/evil/client/dsl.rb
+- lib/evil/client/dsl/base.rb
 - lib/evil/client/dsl/files.rb
+- lib/evil/client/dsl/headers.rb
+- lib/evil/client/dsl/http_method.rb
 - lib/evil/client/dsl/operation.rb
 - lib/evil/client/dsl/operations.rb
+- lib/evil/client/dsl/path.rb
+- lib/evil/client/dsl/query.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/dsl/verifier.rb
 - lib/evil/client/middleware.rb
 - lib/evil/client/middleware/base.rb
 - lib/evil/client/middleware/merge_security.rb