evil-client 0.2.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: e3ce5ab3f46cc4b5835d2ca831403c9f7090c7df
+  data.tar.gz: 0a46913313a0cb465864f58a0af5ca8c69862b2d
+SHA512:
+  metadata.gz: 58cd0f896ad69d342e01eb8d0839012154ab09940138ad337c723bc5b2f9c8e1eb35fa7726b9544e9451c9ac179faa94da5286f3e645711453db67e611ddfaed
+  data.tar.gz: 7a300cbf1de16050958f698ab869679babac7888998b3eacc27de369f8df654ea2b9a26a60c02f0124925fc18e65932536b3e6b5685315f44cbdaae4f54f2243

data/.codeclimate.yml

@@ -0,0 +1,7 @@
+---
+engines:
+  rubocop:
+    enabled: true
+    checks:
+      Rubocop/Style/FrozenStringLiteralComment:
+        enabled: false

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.rspec

@@ -0,0 +1,3 @@
+--require spec_helper
+--format documentation
+--color

data/.rubocop.yml

@@ -0,0 +1,98 @@
+---
+AllCops:
+  DisplayCopNames:    true
+  DisplayStyleGuide:  true
+  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:
+  Enabled: false
+
+Style/Lambda:
+  Exclude:
+    - spec/**/*_spec.rb
+
+Style/LambdaCall:
+  Enabled: false
+
+Style/ModuleFunction:
+  Enabled: false
+
+Style/RaiseArgs:
+  EnforcedStyle: compact
+
+Style/Semicolon:
+  Exclude:
+    - spec/**/*_spec.rb
+
+Style/SignalException:
+  EnforcedStyle: semantic
+
+Style/SingleLineBlockParams:
+  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/.travis.yml

@@ -0,0 +1,17 @@
+---
+sudo:     false
+language: ruby
+cache:    bundler
+script:
+  - bundle exec rspec
+  - bundle exec rubocop
+rvm:
+  - '2.3.0'
+  - ruby-head
+  - jruby-9.1.0.0
+  - jruby-head
+before_install: gem install bundler -v 1.12.5
+matrix:
+  allow_failures:
+    - rvm: ruby-head
+    - rvm: jruby-head

data/Gemfile

@@ -0,0 +1,9 @@
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in evil-client.gemspec
+gemspec
+
+group :development, :test do
+  gem "pry",        platform: :mri
+  gem "pry-byebug", platform: :mri
+end

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Andrew Kozin (aka nepalez), andrew.kozin@gmail.com
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,144 @@
+# Evil::Client
+
+Human-friendly DSL for writing HTTP(s) clients in Ruby
+
+<a href="https://evilmartians.com/">
+<img src="https://evilmartians.com/badges/sponsored-by-evil-martians.svg" alt="Sponsored by Evil Martians" width="236" height="54"></a>
+
+[![Gem Version][gem-badger]][gem]
+[![Build Status][travis-badger]][travis]
+[![Dependency Status][gemnasium-badger]][gemnasium]
+[![Code Climate][codeclimate-badger]][codeclimate]
+[![Inline docs][inch-badger]][inch]
+
+## Intro
+
+The gem allows writing http(s) clients in a way close to [Swagger][swagger] specifications. Like in Swagger, you need to specify models and operations in domain-specific terms. In addition, the gem supports settings and scopes for instantiating clients and sending requests in idiomatic Ruby.
+
+The gem stands away from mutable states and monkey patching when possible. To support multithreading all instances are immutable (though not frozen to avoid performance loss). Its DSL is backed on top of [dry-initializer][dry-initializer] gem, and supposes heavy usage of [dry-types][dry-types] system of contracts.
+
+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
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'evil-client'
+```
+
+And then execute:
+
+```shell
+$ bundle
+```
+
+Or install it yourself as:
+
+```shell
+$ gem install evil-client
+```
+
+## Synopsis
+
+The following example gives an idea of how a client to remote API looks like when written on top of `Evil::Client` using [dry-types][dry-types]-based contracts.
+
+```ruby
+require "evil-client"
+require "dry-types"
+
+class CatsClient < Evil::Client
+  # describe a client-specific model of cat (the furry pinnacle of evolution)
+  class Cat < Evil::Client::Model
+    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 }
+  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!
+  end
+
+  # Define a base url using
+  base_url do |settings|
+    "https://#{settings.domain}.example.com/api/v#{settings.version}/"
+  end
+
+  # Definitions shared by all operations
+  operation do |settings|
+    security { basic_auth settings.user, settings.password }
+  end
+
+  # Operation-specific definition to update a cat by id
+  # This provides low-level DSL `operations[:update_cat].call`
+  operation :update_cat do |settings|
+    http_method :patch
+    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
+    end
+
+    response 200 do |body:, **|
+      Cat.new JSON.parse(body) # define that the body should be wrapped to cat
+    end
+
+    response 422, raise: true do |body:, **|
+      JSON.parse(body) # expect 422 to return json data
+    end
+  end
+
+  # Add top-level DSL
+  scope :cats do
+    scope do |id|
+      def find(**data)
+        operations[:update_cat].call(id: id, **data)
+      end
+    end
+  end
+end
+
+# Instantiate a client with concrete settings
+cat_client = CatClient.new "awesome-cats", # domain
+                           version: 1,
+                           user: "cat_lover",
+                           password: "purr"
+
+# Use low-level DSL to send requests
+cat_client.operations[:update_cat].call id:    4,
+                                        age:   10,
+                                        name:  "Agamemnon",
+                                        color: "tabby"
+
+# Use top-level DSL for the same request
+cat_client.cats[4].call(age: 10, name: "Agamemnon", color: "tabby")
+
+# Both the methods send `PATCH https://awesom-cats.example.com/api/v1/cats/7`
+# with a specified body and headers (authorization via basic_auth)
+```
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+
+[codeclimate-badger]: https://img.shields.io/codeclimate/github/evilmartians/evil-client.svg?style=flat
+[codeclimate]: https://codeclimate.com/github/evilmartians/evil-client
+[gem-badger]: https://img.shields.io/gem/v/evil-client.svg?style=flat
+[gem]: https://rubygems.org/gems/evil-client
+[gemnasium-badger]: https://img.shields.io/gemnasium/evilmartians/evil-client.svg?style=flat
+[gemnasium]: https://gemnasium.com/evilmartians/evil-client
+[inch-badger]: http://inch-ci.org/github/evilmartians/evil-client.svg
+[inch]: https://inch-ci.org/github/evilmartians/evil-client
+[travis-badger]: https://img.shields.io/travis/evilmartians/evil-client/master.svg?style=flat
+[travis]: https://travis-ci.org/evilmartians/evil-client

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec

data/docs/base_url.md

@@ -0,0 +1,38 @@
+Use `base_url` to define a base url, [operation paths][path] are relative to.
+
+You can use [`settings`][settings] as the only argument of the declaration block.
+
+```ruby
+require "evil-client"
+require "dry-types"
+
+class CatsClient < Evil::Client
+  settings do
+    option :version, type: Dry::Types["coercible.int"], default: proc { 1 }
+  end
+  
+  base_url do |settings|
+    "https://cats.example.com/v#{settings.version}"
+  end
+  
+  operation :find_cats do |_settings|
+    http_method :get
+    path { "cats" }
+  end
+end
+```
+
+After a client's instantiation...
+
+```ruby
+client = CatsClient.new version: 3
+```
+
+...the following call will send a request `GET https://example.com/v3/cats`.
+
+```ruby
+client.operations[:find_cat].call
+```
+
+[settings]:
+[path]:

data/docs/documentation.md

@@ -0,0 +1,9 @@
+Use the `documentation` to provide reference to online docs for the current operation.
+
+```ruby
+operation :find_cat do |settings| # remember that you have access to settings
+  documentation "https://cats.example.com/v#{settings.version}/docs/find_cats"
+end
+```
+
+The link will be shown in exceptions risen when either request or response mismatches type constraints.

data/docs/headers.md

@@ -0,0 +1,59 @@
+Use method `headers` to add several headers to a request. The declaration should have a block with several `attributes` describing corresponding headers.
+
+```ruby
+operation :find_cat do |settings|
+  headers do
+    attribute :token if settings.version > 1
+    attribute :id
+  end
+end
+```
+
+The syntax of the attribute declaration is exactly the same as of [Evil::Client::Model][model]. Type constraints and default values are available.
+
+All values for the headers will be taken from a request options:
+
+```ruby
+# Sends a request with headers { "id" => 43 }
+client.options[:find_cat].call id: 43
+```
+
+As a rule, you shouldn't define authorization headers in this way. Use [the security method][security] instead.
+
+Default headers can be declared for every request via anonymous operation. **Notice** that a default headers can be reloaded for specific operation as a whole. New declaration will overwrite all the default set headers instead of merging to them.
+
+```ruby
+operation do
+  headers do
+    attribute :id
+  end
+end
+
+operation :find_cat do
+  headers do
+    attribute :cat_id
+  end
+end
+
+# later at the runtime the following call
+# will send request with { "cat_id" => 4 } header only
+client.operations[:find_cat].call id: 1, cat_id: 4
+```
+
+According to [RFC-2616][rfc-2616], headers are case-insensitive. Inside [middleware][middleware] they are forced to lower case.
+
+For example, while the following declaration is valid by itself, only value from `Foo` option will be sent to remote server:
+
+```ruby
+operation do
+  headers do
+    attribute :foo
+    attribute :Foo
+  end
+end
+```
+
+[rfc-2616]: https://www.w3.org/Protocols/rfc2616/rfc2616-sec4.html#sec4.2
+[security]:
+[model]:
+[middleware]: