clientura 0.0.6

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 6b7bda8b3a6c0e15f5b3418a3cf6ef76f45d9cd8
+  data.tar.gz: 4554b988da1924debfb11617ae933d055433fa10
+SHA512:
+  metadata.gz: 21d8c32b6ecb382d17c9a595d0dc1581fff329c76e5bbf5423e8609186a97e45a8ffbb30731f1a15fef8365c1524d9327c39a63d0df1b79278b42f9b98b0ea13
+  data.tar.gz: 89f8500ad7c15952200fe4c47554bc4a888082ef429e9ccef12fa656a6224aa11a09cf5b02121db8aa5214d1dcd6186ee1a76df2f2c6a50ac97485a1095e37d3

data/.codeclimate.yml

@@ -0,0 +1,29 @@
+---
+engines:
+  bundler-audit:
+    enabled: true
+  duplication:
+    enabled: true
+    config:
+      languages:
+      - ruby
+      - javascript
+      - python
+      - php
+  fixme:
+    enabled: true
+  rubocop:
+    enabled: true
+ratings:
+  paths:
+  - "**.inc"
+  - "**.js"
+  - "**.jsx"
+  - "**.module"
+  - "**.php"
+  - "**.py"
+  - "**.rb"
+exclude_paths:
+- spec/
+- Gemfile*
+- clientura.gemspec

data/.rspec

@@ -0,0 +1,2 @@
+--require spec_helper
+--color

data/.rubocop.yml

@@ -0,0 +1,10 @@
+AllCops:
+  TargetRubyVersion: 2.2
+
+  Exclude:
+    - Gemfile*
+    - clientura.gemspec
+    - spec/**/*
+
+Documentation:
+    Enabled: false

data/.ruby-gemset

@@ -0,0 +1 @@
+clientura

data/.ruby-version

@@ -0,0 +1 @@
+ruby-2.2.3

data/.travis.yml

@@ -0,0 +1,10 @@
+script: bundle exec rake
+sudo: false
+# cache: bundler
+# before_install:
+#   # - export DISPLAY=:99.0
+#   # - sh -e /etc/init.d/xvfb start
+#   - gem install bundler
+# # before_script:
+# #   - cp config/database.yml.sample config/database.yml
+# #   - psql -c 'create database project_test' -U postgres

data/Gemfile

@@ -0,0 +1,29 @@
+source 'http://rubygems.org'
+# Add dependencies required to use your gem here.
+# Example:
+#   gem "activesupport", ">= 2.3.5"
+
+# Add dependencies to develop your gem here.
+# Include everything needed to run rake, tests, features, etc.
+
+gem 'http', '~> 1.0'
+gem 'concurrent-ruby', '~> 1.0'
+gem 'concurrent-ruby-edge', '~> 0.2'
+gem 'concurrent-ruby-ext', '~> 1.0'
+gem 'activesupport', '>= 4.0'
+
+group :development, :test do
+  gem 'rspec'
+  gem 'rdoc'
+  gem 'bundler'
+  gem 'jeweler'
+  gem 'simplecov'
+  gem 'rubocop'
+  gem 'pry'
+
+  gem 'sinatra'
+  gem 'sinatra-contrib'
+  gem 'rack', require: ['rack', 'rack/handler/webrick']
+  gem 'thin'
+  gem 'codeclimate-test-reporter', require: nil
+end

data/Gemfile.lock

@@ -0,0 +1,166 @@
+GEM
+  remote: http://rubygems.org/
+  specs:
+    activesupport (4.2.5.1)
+      i18n (~> 0.7)
+      json (~> 1.7, >= 1.7.7)
+      minitest (~> 5.1)
+      thread_safe (~> 0.3, >= 0.3.4)
+      tzinfo (~> 1.1)
+    addressable (2.4.0)
+    ast (2.2.0)
+    backports (3.6.8)
+    builder (3.2.2)
+    codeclimate-test-reporter (0.5.0)
+      simplecov (>= 0.7.1, < 1.0.0)
+    coderay (1.1.0)
+    concurrent-ruby (1.0.0)
+    concurrent-ruby-edge (0.2.0)
+      concurrent-ruby (~> 1.0.0)
+    concurrent-ruby-ext (1.0.0)
+      concurrent-ruby (~> 1.0.0)
+    daemons (1.2.3)
+    descendants_tracker (0.0.4)
+      thread_safe (~> 0.3, >= 0.3.1)
+    diff-lcs (1.2.5)
+    docile (1.1.5)
+    domain_name (0.5.20160128)
+      unf (>= 0.0.5, < 1.0.0)
+    eventmachine (1.0.9.1)
+    faraday (0.9.2)
+      multipart-post (>= 1.2, < 3)
+    git (1.2.9.1)
+    github_api (0.13.1)
+      addressable (~> 2.4.0)
+      descendants_tracker (~> 0.0.4)
+      faraday (~> 0.8, < 0.10)
+      hashie (>= 3.4)
+      multi_json (>= 1.7.5, < 2.0)
+      oauth2
+    hashie (3.4.3)
+    highline (1.7.8)
+    http (1.0.2)
+      addressable (~> 2.3)
+      http-cookie (~> 1.0)
+      http-form_data (~> 1.0.1)
+      http_parser.rb (~> 0.6.0)
+    http-cookie (1.0.2)
+      domain_name (~> 0.5)
+    http-form_data (1.0.1)
+    http_parser.rb (0.6.0)
+    i18n (0.7.0)
+    jeweler (2.0.1)
+      builder
+      bundler (>= 1.0)
+      git (>= 1.2.5)
+      github_api
+      highline (>= 1.6.15)
+      nokogiri (>= 1.5.10)
+      rake
+      rdoc
+    json (1.8.3)
+    jwt (1.5.1)
+    method_source (0.8.2)
+    mini_portile2 (2.0.0)
+    minitest (5.8.4)
+    multi_json (1.11.2)
+    multi_xml (0.5.5)
+    multipart-post (2.0.0)
+    nokogiri (1.6.7.2)
+      mini_portile2 (~> 2.0.0.rc2)
+    oauth2 (1.1.0)
+      faraday (>= 0.8, < 0.10)
+      jwt (~> 1.0, < 1.5.2)
+      multi_json (~> 1.3)
+      multi_xml (~> 0.5)
+      rack (>= 1.2, < 3)
+    parser (2.3.0.5)
+      ast (~> 2.2)
+    powerpack (0.1.1)
+    pry (0.10.3)
+      coderay (~> 1.1.0)
+      method_source (~> 0.8.1)
+      slop (~> 3.4)
+    rack (1.6.4)
+    rack-protection (1.5.3)
+      rack
+    rack-test (0.6.3)
+      rack (>= 1.0)
+    rainbow (2.1.0)
+    rake (10.5.0)
+    rdoc (4.2.2)
+      json (~> 1.4)
+    rspec (3.4.0)
+      rspec-core (~> 3.4.0)
+      rspec-expectations (~> 3.4.0)
+      rspec-mocks (~> 3.4.0)
+    rspec-core (3.4.2)
+      rspec-support (~> 3.4.0)
+    rspec-expectations (3.4.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.4.0)
+    rspec-mocks (3.4.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.4.0)
+    rspec-support (3.4.1)
+    rubocop (0.37.2)
+      parser (>= 2.3.0.4, < 3.0)
+      powerpack (~> 0.1)
+      rainbow (>= 1.99.1, < 3.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (~> 0.3)
+    ruby-progressbar (1.7.5)
+    simplecov (0.11.2)
+      docile (~> 1.1.0)
+      json (~> 1.8)
+      simplecov-html (~> 0.10.0)
+    simplecov-html (0.10.0)
+    sinatra (1.4.7)
+      rack (~> 1.5)
+      rack-protection (~> 1.4)
+      tilt (>= 1.3, < 3)
+    sinatra-contrib (1.4.6)
+      backports (>= 2.0)
+      multi_json
+      rack-protection
+      rack-test
+      sinatra (~> 1.4.0)
+      tilt (>= 1.3, < 3)
+    slop (3.6.0)
+    thin (1.6.4)
+      daemons (~> 1.0, >= 1.0.9)
+      eventmachine (~> 1.0, >= 1.0.4)
+      rack (~> 1.0)
+    thread_safe (0.3.5)
+    tilt (2.0.2)
+    tzinfo (1.2.2)
+      thread_safe (~> 0.1)
+    unf (0.1.4)
+      unf_ext
+    unf_ext (0.0.7.2)
+    unicode-display_width (0.3.1)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  activesupport (>= 4.0)
+  bundler
+  codeclimate-test-reporter
+  concurrent-ruby (~> 1.0)
+  concurrent-ruby-edge (~> 0.2)
+  concurrent-ruby-ext (~> 1.0)
+  http (~> 1.0)
+  jeweler
+  pry
+  rack
+  rdoc
+  rspec
+  rubocop
+  simplecov
+  sinatra
+  sinatra-contrib
+  thin
+
+BUNDLED WITH
+   1.11.2

data/LICENSE.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2016 Vlad Shmyhlo
+
+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,71 @@
+# Clientura [![Build Status](https://travis-ci.org/v-shmyhlo/clientura.svg?branch=master)](https://travis-ci.org/v-shmyhlo/clientura) [![Test Coverage](https://codeclimate.com/github/v-shmyhlo/clientura/badges/coverage.svg)](https://codeclimate.com/github/v-shmyhlo/clientura/coverage) [![Code Climate](https://codeclimate.com/github/v-shmyhlo/clientura/badges/gpa.svg)](https://codeclimate.com/github/v-shmyhlo/clientura) [![Issue Count](https://codeclimate.com/github/v-shmyhlo/clientura/badges/issue_count.svg)](https://codeclimate.com/github/v-shmyhlo/clientura)
+
+### Basic concepts
+
+Create client class
+``` ruby
+class RandomApiClient
+  include Clientura::Client
+end
+```
+Define middleware (blocks which can be composed to configure your request before it is sent)
+```ruby
+class RandomApiClient
+  include Clientura::Client
+
+  middleware :with_token, -> { headers(token: client.config[:token]) }
+end
+```
+Define pipes (blocks which can be composed to process response)
+```ruby
+class RandomApiClient
+  include Clientura::Client
+
+  middleware :with_token, -> { headers(token: client.config[:token]) }
+
+  pipe :body_retriever, -> (res) { res.body.to_s }
+  pipe :parser, -> (res, parser) { parser.parse res }
+  pipe :data_retriever, -> (res) { res['data'] }
+end
+```
+Compose this stuff!
+```ruby
+class RandomApiClient
+  include Clientura::Client
+
+  middleware :with_token, -> { headers(token: client.config[:token]) }
+
+  pipe :body_retriever, -> (res) { res.body.to_s }
+  pipe :parser, -> (res, parser) { parser.parse res }
+  pipe :data_retriever, -> (res) { res['data'] }
+
+  use_middleware :with_token do
+    pipe_through :body_retriever, [:parser, JSON], :data_retriever do
+      get :comments # implicit path 'comments'
+      get :users, path: 'api/users' # explicit path
+      get :user, path: -> (params) { "api/users/#{params[:id]}"} # dynamic path
+    end
+  end
+end
+```
+Also instance should be created with token which will be used by middleware
+```ruby
+# ...
+  def initialize(token:)
+    save_config token: token
+  end
+# ...
+```
+Instantiate and use!
+```ruby
+client = RandomApiClient.new(token: 'Moms Birthday')
+client.comments
+client.comments_promise # yeap, asyncrony baby, backed by concurrent-ruby
+client.users_promise.value # just retrieve result from promise
+client.user(id: 1)
+client.user_promise(id: 1).then do |data_retrieved_through_pipes|
+  # process it asyncronously ...
+end
+```
+
+### See more in [spec/clientura/adequate_spec.rb](spec/clientura/adequate_spec.rb)

data/README.rdoc

@@ -0,0 +1,19 @@
+= clientura
+
+Description goes here.
+
+== Contributing to clientura
+ 
+* Check out the latest master to make sure the feature hasn't been implemented or the bug hasn't been fixed yet.
+* Check out the issue tracker to make sure someone already hasn't requested it and/or contributed it.
+* Fork the project.
+* Start a feature/bugfix branch.
+* Commit and push until you are happy with your contribution.
+* Make sure to add tests for it. This is important so I don't break it in a future version unintentionally.
+* Please try not to mess with the Rakefile, version, or history. If you want to have your own version, or is otherwise necessary, that is fine, but please isolate to its own commit so I can cherry-pick around it.
+
+== Copyright
+
+Copyright (c) 2016 Vlad Shmyhlo. See LICENSE.txt for
+further details.
+

data/Rakefile

@@ -0,0 +1,52 @@
+# encoding: utf-8
+
+require 'rubygems'
+require 'bundler'
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts 'Run `bundle install` to install missing gems'
+  exit e.status_code
+end
+require 'rake'
+
+require 'jeweler'
+Jeweler::Tasks.new do |gem|
+  # gem is a Gem::Specification...
+  # see http://guides.rubygems.org/specification-reference/ for more options
+  gem.name = 'clientura'
+  gem.homepage = 'http://github.com/v-shmyhlo/clientura'
+  gem.license = 'MIT'
+  gem.summary = 'DSL for defining HTTP clients'
+  gem.description = 'DSL for defining HTTP clients'
+  gem.email = 'aion.stu@gmail.com'
+  gem.authors = ['Vlad Shmyhlo']
+  # dependencies defined in Gemfile
+end
+Jeweler::RubygemsDotOrgTasks.new
+
+require 'rspec/core'
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new(:spec) do |spec|
+  spec.pattern = FileList['spec/**/*_spec.rb']
+end
+
+desc 'Code coverage detail'
+task :simplecov do
+  ENV['COVERAGE'] = 'true'
+  Rake::Task['spec'].execute
+  `google-chrome coverage/index.html`
+end
+
+task default: :spec
+
+require 'rdoc/task'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ''
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "clientura #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+0.0.6

data/clientura.gemspec

@@ -0,0 +1,114 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run 'rake gemspec'
+# -*- encoding: utf-8 -*-
+# stub: clientura 0.0.6 ruby lib
+
+Gem::Specification.new do |s|
+  s.name = "clientura"
+  s.version = "0.0.6"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.require_paths = ["lib"]
+  s.authors = ["Vlad Shmyhlo"]
+  s.date = "2016-03-04"
+  s.description = "DSL for defining HTTP clients"
+  s.email = "aion.stu@gmail.com"
+  s.extra_rdoc_files = [
+    "LICENSE.txt",
+    "README.md",
+    "README.rdoc"
+  ]
+  s.files = [
+    ".codeclimate.yml",
+    ".rspec",
+    ".rubocop.yml",
+    ".ruby-gemset",
+    ".ruby-version",
+    ".travis.yml",
+    "Gemfile",
+    "Gemfile.lock",
+    "LICENSE.txt",
+    "README.md",
+    "README.rdoc",
+    "Rakefile",
+    "VERSION",
+    "clientura.gemspec",
+    "lib/clientura.rb",
+    "lib/clientura/client.rb",
+    "lib/clientura/client/endpoint.rb",
+    "lib/clientura/client/middleware_function_context.rb",
+    "lib/clientura/client/request.rb",
+    "lib/clientura/version.rb",
+    "spec/clientura/adequate_spec.rb",
+    "spec/clientura/client_spec.rb",
+    "spec/clientura_spec.rb",
+    "spec/spec_helper.rb",
+    "spec/support/test_server.rb"
+  ]
+  s.homepage = "http://github.com/v-shmyhlo/clientura"
+  s.licenses = ["MIT"]
+  s.rubygems_version = "2.4.8"
+  s.summary = "DSL for defining HTTP clients"
+
+  if s.respond_to? :specification_version then
+    s.specification_version = 4
+
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+      s.add_runtime_dependency(%q<http>, ["~> 1.0"])
+      s.add_runtime_dependency(%q<concurrent-ruby>, ["~> 1.0"])
+      s.add_runtime_dependency(%q<concurrent-ruby-edge>, ["~> 0.2"])
+      s.add_runtime_dependency(%q<concurrent-ruby-ext>, ["~> 1.0"])
+      s.add_runtime_dependency(%q<activesupport>, [">= 4.0"])
+      s.add_development_dependency(%q<rspec>, [">= 0"])
+      s.add_development_dependency(%q<rdoc>, [">= 0"])
+      s.add_development_dependency(%q<bundler>, [">= 0"])
+      s.add_development_dependency(%q<jeweler>, [">= 0"])
+      s.add_development_dependency(%q<simplecov>, [">= 0"])
+      s.add_development_dependency(%q<rubocop>, [">= 0"])
+      s.add_development_dependency(%q<pry>, [">= 0"])
+      s.add_development_dependency(%q<sinatra>, [">= 0"])
+      s.add_development_dependency(%q<sinatra-contrib>, [">= 0"])
+      s.add_development_dependency(%q<rack>, [">= 0"])
+      s.add_development_dependency(%q<thin>, [">= 0"])
+      s.add_development_dependency(%q<codeclimate-test-reporter>, [">= 0"])
+    else
+      s.add_dependency(%q<http>, ["~> 1.0"])
+      s.add_dependency(%q<concurrent-ruby>, ["~> 1.0"])
+      s.add_dependency(%q<concurrent-ruby-edge>, ["~> 0.2"])
+      s.add_dependency(%q<concurrent-ruby-ext>, ["~> 1.0"])
+      s.add_dependency(%q<activesupport>, [">= 4.0"])
+      s.add_dependency(%q<rspec>, [">= 0"])
+      s.add_dependency(%q<rdoc>, [">= 0"])
+      s.add_dependency(%q<bundler>, [">= 0"])
+      s.add_dependency(%q<jeweler>, [">= 0"])
+      s.add_dependency(%q<simplecov>, [">= 0"])
+      s.add_dependency(%q<rubocop>, [">= 0"])
+      s.add_dependency(%q<pry>, [">= 0"])
+      s.add_dependency(%q<sinatra>, [">= 0"])
+      s.add_dependency(%q<sinatra-contrib>, [">= 0"])
+      s.add_dependency(%q<rack>, [">= 0"])
+      s.add_dependency(%q<thin>, [">= 0"])
+      s.add_dependency(%q<codeclimate-test-reporter>, [">= 0"])
+    end
+  else
+    s.add_dependency(%q<http>, ["~> 1.0"])
+    s.add_dependency(%q<concurrent-ruby>, ["~> 1.0"])
+    s.add_dependency(%q<concurrent-ruby-edge>, ["~> 0.2"])
+    s.add_dependency(%q<concurrent-ruby-ext>, ["~> 1.0"])
+    s.add_dependency(%q<activesupport>, [">= 4.0"])
+    s.add_dependency(%q<rspec>, [">= 0"])
+    s.add_dependency(%q<rdoc>, [">= 0"])
+    s.add_dependency(%q<bundler>, [">= 0"])
+    s.add_dependency(%q<jeweler>, [">= 0"])
+    s.add_dependency(%q<simplecov>, [">= 0"])
+    s.add_dependency(%q<rubocop>, [">= 0"])
+    s.add_dependency(%q<pry>, [">= 0"])
+    s.add_dependency(%q<sinatra>, [">= 0"])
+    s.add_dependency(%q<sinatra-contrib>, [">= 0"])
+    s.add_dependency(%q<rack>, [">= 0"])
+    s.add_dependency(%q<thin>, [">= 0"])
+    s.add_dependency(%q<codeclimate-test-reporter>, [">= 0"])
+  end
+end
+

data/lib/clientura/client/endpoint.rb

@@ -0,0 +1,5 @@
+module Clientura
+  module Client
+    Endpoint = Struct.new(:verb, :path, :middleware, :pipes)
+  end
+end

data/lib/clientura/client/middleware_function_context.rb

@@ -0,0 +1,21 @@
+module Clientura
+  module Client
+    class MiddlewareFunctionContext < SimpleDelegator
+      attr_accessor :client, :args
+
+      def initialize(request:, client:, args:, callable:, config:)
+        @request  = request
+        @client   = client
+        @args     = args
+        @callable = callable
+        @config   = config
+
+        super @request
+      end
+
+      def call
+        instance_exec(*@config, &@callable)
+      end
+    end
+  end
+end

data/lib/clientura/client/request.rb

@@ -0,0 +1,34 @@
+module Clientura
+  module Client
+    class Request < SimpleDelegator
+      attr_reader :config, :http
+
+      def initialize(http = HTTP.headers({}),
+                     config = { uri: '', params: {}, json: nil })
+        super http
+        @http   = http
+        @config = config
+      end
+
+      def update(key)
+        Request.new http, config.merge(key => yield(config[key]))
+      end
+
+      [:get, :post, :put, :patch, :delete].each do |verb|
+        define_method verb do |path, **opts|
+          super(*build_request_arguments(path, opts))
+        end
+      end
+
+      def build_request_arguments(path, **opts)
+        opts[:params] = config.fetch(:params) if config[:params].present?
+        opts[:json] = config.fetch(:json) if config[:json].present?
+        [URI.join(config.fetch(:uri), path), opts]
+      end
+
+      def headers(*args)
+        Request.new(http.headers(*args), config)
+      end
+    end
+  end
+end