api_recipes 0.0.1

checksums.yaml

@@ -0,0 +1,15 @@
+---
+!binary "U0hBMQ==":
+  metadata.gz: !binary |-
+    NzBiNzgwZTQyYjI2MmU3NDk2Mzg3ZTA2ZmYzMWViM2E1YmRlN2RlNw==
+  data.tar.gz: !binary |-
+    N2Y1YTc4OTcxZGI3NWYxYWJmMDAxZWY4N2ViZTA3N2EyYzdhY2JmMA==
+SHA512:
+  metadata.gz: !binary |-
+    M2VhNDJlZjYxMzQ3YjkxNDkyOGFlYTI0OGI5MTJjMjM1ZWJmMWU5MTg4M2Rl
+    NjRlOWViOWVjNTk0NmRiZWYyMTA2MjAzNGFkYWU0YTc0YTgzNmUyNDE1NjA5
+    N2ZkZTEzZTNjMDUxNTY1YTE3N2Y1YTUxYzdiNTc1NGRlMDU1ZWQ=
+  data.tar.gz: !binary |-
+    NzQxMWY0NGI3NzQzMzBlZDFjNWM0MjE0M2ZkNzQ1NTdjMGU5YmI2NTAzYWZi
+    ZTUzNjk5NDBiYzQ4ZjQ4MGY0ZWEzYzAxZjFkZGVjMmM1ZTVlZWM1NjljNjJj
+    NTQ0Nzg3MWU0OWU5MDE4M2UyMzAxNzY5NDk0MjY4ZjY3MGFhZDc=

data/.gitignore

@@ -0,0 +1,16 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.orig
+.idea
+.rvmrc
+.ruby-version
+.ruby-gemset
+.DS_Store
+*.gem

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.travis.yml

@@ -0,0 +1,10 @@
+language: ruby
+rvm:
+  - 1.9.3
+  - 2.0.0
+  - 2.1.0
+  - 2.2.0
+  - 2.2.3
+notifications:
+  email: false
+bundler_args: --without development

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,13 @@
+# Contributor Code of Conduct
+
+As contributors and maintainers of this project, we pledge to respect all people who contribute through reporting issues, posting feature requests, updating documentation, submitting pull requests or patches, and other activities.
+
+We are committed to making participation in this project a harassment-free experience for everyone, regardless of level of experience, gender, gender identity and expression, sexual orientation, disability, personal appearance, body size, race, ethnicity, age, or religion.
+
+Examples of unacceptable behavior by participants include the use of sexual language or imagery, derogatory comments or personal attacks, trolling, public or private harassment, insults, or other unprofessional conduct.
+
+Project maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct. Project maintainers who do not follow the Code of Conduct may be removed from the project team.
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by opening an issue or contacting one or more of the project maintainers.
+
+This Code of Conduct is adapted from the [Contributor Covenant](http://contributor-covenant.org), version 1.0.0, available at [http://contributor-covenant.org/version/1/0/0/](http://contributor-covenant.org/version/1/0/0/)

data/Gemfile

@@ -0,0 +1,16 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in api_recipes.gemspec
+gemspec
+
+gem 'rake', '~> 10.0'
+
+group :development do
+  gem 'guard',          '~> 2.13.0'
+  gem 'guard-rspec',    '~> 4.6.4'
+  gem 'guard-bundler',  '~> 2.1.0'
+end
+
+group :test do
+  gem 'rspec', '~> 3.3'
+end

data/Guardfile

@@ -0,0 +1,15 @@
+guard :rspec, cmd: 'bundle exec rspec' do
+  require 'guard/rspec/dsl'
+  dsl = Guard::RSpec::Dsl.new(self)
+
+
+  # RSpec files
+  rspec = dsl.rspec
+  watch(rspec.spec_helper) { rspec.spec_dir }
+  watch(rspec.spec_support) { rspec.spec_dir }
+  watch(rspec.spec_files)
+
+  # Ruby files
+  ruby = dsl.ruby
+  dsl.watch_spec_files_for(ruby.lib_files)
+end

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 Alessandro Verlato
+
+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,59 @@
+[![Code Climate](https://codeclimate.com/github/madAle/api_recipes/badges/gpa.svg)](https://codeclimate.com/github/madAle/api_recipes)
+
+# ApiRecipes
+
+Consume HTTP APIs with style
+   
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'api_recipes'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install api_recipes
+    
+## Compatibility
+
+Ruby 1.9.3 or higher.
+
+## Usage
+
+... in progress. 
+
+In the meantime take a look at the ``` examples ``` folder. Thank you.
+
+## TODO
+
+* Write specs
+* Write a good Usage
+* Add more examples
+* Delete this TODO section
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. 
+You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update 
+the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for 
+the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/madAle/api_recipes. 
+This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to 
+the [Contributor Covenant](contributor-covenant.org) code of conduct.
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+

data/Rakefile

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

data/api_recipes.gemspec

@@ -0,0 +1,25 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'api_recipes/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'api_recipes'
+  spec.version       = ApiRecipes::VERSION
+  spec.authors       = ['Alessandro Verlato']
+  spec.email         = ['averlato@gmail.com']
+
+  spec.summary       = %q{Consume HTTP APIs with style}
+  spec.homepage      = 'https://github.com/madAle/api_recipes'
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+  spec.required_ruby_version = '>= 1.9.3'
+
+  spec.add_dependency 'oj', '~> 2.13.0'
+  spec.add_dependency 'oj_mimic_json', '~> 1.0.1'
+  spec.add_dependency 'http', '~> 0.9.0'
+  spec.add_dependency 'activesupport', '>= 4.0.0'
+end

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "api_recipes"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start

data/bin/setup

@@ -0,0 +1,7 @@
+#!/bin/bash
+set -euo pipefail
+IFS=$'\n\t'
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/examples/authorization.rb

@@ -0,0 +1,42 @@
+require 'api_recipes'
+require 'yaml'
+
+# Configure RemoteApi through a yaml file.
+# Take a look at examples/config/apis.yml  for details
+ApiRecipes.configure do |config|
+  config.endpoints_configs = YAML.load_file(File.expand_path('examples/config/apis.yml'))
+end
+
+# Let's create a simple class that uses ApiRecipes
+class MyFancyClass
+  include ApiRecipes
+
+  # Declare the endpoints that we're going to use
+  endpoint :github
+end
+
+# Setup Auth. This will set/replace the HTTP 'Authorization' header with the
+# provided value
+
+# Get your OAUTH token on Github.
+# Navigate Profile => Settings => Personal Access Tokens => Generate new token
+# Copy the generated string and substitute it to YOUR_GITHUB_OAUTH_TOKEN below
+MyFancyClass.github.authorization = 'token YOUR_GITHUB_OAUTH_TOKEN'
+
+MyFancyClass.github.users.list do |users|
+  puts users.collect{ |user| user['login'] }
+end
+
+# From now on every MyFancyClass (and its instances) github's api request will
+# be authenticated through the provided auth
+
+# Get user's usernames from Github's Apis (https://github.com)
+usernames = nil
+MyFancyClass.github.users.list do |users|
+  usernames = users.collect{ |user| user['login'] }
+end
+
+# Get user's repos
+MyFancyClass.github.users.repos(user_id: usernames.first) do |repos|
+  puts repos
+end

data/examples/authorization_with_default_headers.rb

@@ -0,0 +1,41 @@
+require 'api_recipes'
+require 'yaml'
+
+# Configure RemoteApi through a yaml file.
+# Take a look at examples/config/apis.yml  for details
+ApiRecipes.configure do |config|
+  config.endpoints_configs = YAML.load_file(File.expand_path('examples/config/apis.yml'))
+end
+
+# Let's create a simple class that uses ApiRecipes
+class MyFancyClass
+  include ApiRecipes
+
+  # Get your OAUTH token on Github.
+  # Navigate Profile => Settings => Personal Access Tokens => Generate new token
+  # Copy the generated string and substitute it to YOUR_GITHUB_OAUTH_TOKEN below
+
+  MY_CUSTOM_CONFIG = {
+      default_headers: {
+          'Authorization' => 'token YOUR_GITHUB_OAUTH_TOKEN'
+      }
+  }
+
+  # Declare the endpoints that we're going to use
+  # Add some custom configs
+  endpoint :github, MY_CUSTOM_CONFIG
+end
+
+# From now on every MyFancyClass (and its instances) github's api request will
+# be authenticated through the provided Authorization header
+
+# Get user's usernames from Github's Apis (https://github.com)
+usernames = nil
+MyFancyClass.github.users.list do |users|
+  usernames = users.collect{ |user| user['login'] }
+end
+
+# Get user's repos
+MyFancyClass.github.users.repos(user_id: usernames.first) do |repos|
+  puts repos
+end

data/examples/basic_auth.rb

@@ -0,0 +1,32 @@
+require 'api_recipes'
+require 'yaml'
+
+# Configure RemoteApi through a yaml file.
+# Take a look at examples/config/apis.yml  for details
+ApiRecipes.configure do |config|
+  config.endpoints_configs = YAML.load_file(File.expand_path('examples/config/apis.yml'))
+end
+
+# Let's create a simple class that uses ApiRecipes
+class MyFancyClass
+  include ApiRecipes
+
+  # Declare the endpoints that we're going to use
+  endpoint :github
+end
+
+# Setup Basic Auth
+MyFancyClass.github.basic_auth = { user: 'github_username', pass: 'github_password' }
+
+# From now on every github's api request will be authenticated with basic auth
+
+# Get user's usernames from Github's Apis (https://github.com)
+usernames = nil
+MyFancyClass.github.users.list do |users|
+  usernames = users.collect{ |user| user['login'] }
+end
+
+# Get user's repos
+MyFancyClass.github.users.repos(user_id: usernames.first) do |repos|
+  puts repos
+end

data/examples/config/apis.yml

@@ -0,0 +1,43 @@
+github:
+  protocol: https           # Optional, defaults to: 'http'
+  host: api.github.com      # Optional, defaults to: 'localhost'
+  port: 443                 # Optional, defaults to: 80 for http and 443 for https
+  base_path:                # Optional, defaults to: ''
+  api_version:              # Optional, defaults to: ''
+  timeout: 3                # Optional, defaults to: 1 (time expressed in seconds)
+  on_nok_code: :raise       # Optional, defaults to :raise. Possible values: [:do_nothing, :raise, :return_false]
+  default_headers:
+    accept: 'application/vnd.github.v3+json'
+    content_type: 'application/json'
+
+  routes:
+    users:
+      list:
+        path:               # Optional, defaults to: ''
+        method: get         # Optional, defaults to: get
+        ok_code: 200        # Optional, defaults to: 200
+
+      show:
+        path: /:user_id     # You can use :some_param notation and provide params when calling the route (see examples/simple.rb)
+
+      repos:
+        path: /:user_id/repos
+
+
+# Example of test endpoint with minimal configuration and multiple routes
+jsonplaceholder:
+  host: jsonplaceholder.typicode.com
+
+  routes:
+    users:
+      list:
+      show:
+        path: /:user_id     # You can use :some_param notation and provide params when calling the route (see examples/simple.rb)
+
+    posts:
+      list:
+      show:
+        path: /:post_id
+
+      comments:
+        path: /:post_id/comments

data/examples/custom_configs.rb

@@ -0,0 +1,50 @@
+# This example aims to demonstrate how to provide custom configs to endpoints
+
+require 'api_recipes'
+
+# Configure RemoteApi through custom settings
+FAKE_API_SETTINGS = {
+    host: 'jsonplaceholder.typicode.com',
+    routes: {
+        users: {
+            list: nil,
+            show: {
+                path: '/:user_id'
+            }
+        },
+        posts: {
+            list: nil,
+            comments: {
+                path: '/:post_id/comments'
+            }
+        }
+    }
+}
+
+# Let's create a simple class that uses ApiRecipes
+class MyFancyClass
+  include ApiRecipes
+
+  # Declare the endpoints that we're going to use
+  endpoint :fake_api, FAKE_API_SETTINGS
+end
+
+# Let's demonstrate that even a class instance can use enpoints
+fancy_instance = MyFancyClass.new
+
+# Get User's names
+fancy_instance.fake_api.users.list do |users|
+  names = users.collect{ |user| user['name'] }
+  puts "Names: #{names}"
+end
+
+# Collect post ids
+post_ids = nil
+MyFancyClass.fake_api.posts.list do |posts|
+  post_ids = posts.map{ |post| post['id'] }
+end
+
+# Fetch post's comments
+fancy_instance.fake_api.posts.comments(post_id: post_ids.last) do |comments|
+  puts "Comments: #{comments}"
+end

data/examples/delete_me.rb

@@ -0,0 +1,21 @@
+require 'api_recipes'
+require 'yaml'
+
+ApiRecipes.configure do |config|
+  config.endpoints_configs = YAML.load_file(File.expand_path('examples/config/apis.yml'))
+end
+
+class Foo
+  include ApiRecipes
+
+  endpoint :jsonplaceholder
+end
+
+puts 'Use from class:'
+puts Foo.jsonplaceholder.users.list
+
+f1 = Foo.new
+
+puts "\n\nUse from instance:"
+sleep 1
+puts f1.jsonplaceholder.users.list

data/examples/multiple_endpoints.rb

@@ -0,0 +1,54 @@
+require 'api_recipes'
+require 'yaml'
+
+# Configure RemoteApi through a yaml file.
+# Take a look at examples/config/apis.yml  for details
+ApiRecipes.configure do |config|
+  config.endpoints_configs = YAML.load_file(File.expand_path('examples/config/apis.yml'))
+end
+
+# Let's create a simple class that uses ApiRecipes
+class MyFancyClass
+  include ApiRecipes
+
+  # Declare the endpoints that we're going to use
+  endpoint :jsonplaceholder
+  endpoint :github
+end
+
+# Get users from JSONPlaceholder (http://jsonplaceholder.typicode.com/users)
+MyFancyClass.jsonplaceholder.users.list do |users|
+  puts 'Usernames:'
+  puts users.collect{ |user| user['name'] }
+end
+
+# Get posts from JSONPlaceholder (http://jsonplaceholder.typicode.com/posts)
+post_ids = nil
+MyFancyClass.jsonplaceholder.posts.list do |posts|
+  post_ids = posts.map{ |post| post['id'] }
+end
+
+puts "\n\n\n\n"
+# Get first post's comments from JSONPlaceholder
+# http://jsonplaceholder.typicode.com/posts/1/comments
+MyFancyClass.jsonplaceholder.posts.comments(post_id: post_ids.first) do |comments|
+  puts "Comments:"
+  puts comments
+end
+
+puts "\n\n\n\n"
+# Get also Github users
+# Warning: Github has a low rate limit for unauthorized api requests.
+MyFancyClass.github.users.list do |body, status_code, status_message|
+  puts "Response: #{status_code}: #{status_message}"
+  puts "Data: #{body}"
+end
+
+# If you need a 'raw' response (e.g. the response must not automatically be
+# parsed as JSON) just don't provide a block and the result will be an
+# HTTP::Response object. See https://github.com/httprb/http for further details
+
+response = MyFancyClass.github.users.list
+puts response.code    # e.g. 200
+puts response.reason  # e.g. OK
+puts response.body    # e.g  Some response body (not necessarely JSON)

data/examples/simple_usage.rb

@@ -0,0 +1,32 @@
+require 'api_recipes'
+require 'yaml'
+
+# Configure RemoteApi through a yaml file.
+# Take a look at examples/config/apis.yml  for details
+ApiRecipes.configure do |config|
+  config.endpoints_configs = YAML.load_file(File.expand_path('examples/config/apis.yml'))
+end
+
+# Let's create a simple class that uses ApiRecipes
+class MyFancyClass
+  include ApiRecipes
+
+  # Declare the endpoints that we're going to use
+  # Add some custom configs
+  endpoint :github
+end
+
+
+# Warning: Github has a low rate limit for unauthorized api requests.
+
+
+# Get user's usernames from Github's Apis (https://github.com)
+usernames = nil
+MyFancyClass.github.users.list do |users|
+  usernames = users.collect{ |user| user['login'] }
+end
+
+# Get user's repos
+MyFancyClass.github.users.repos(user_id: usernames.first) do |repos|
+  puts repos
+end

data/lib/api_recipes/configuration.rb

@@ -0,0 +1,16 @@
+module ApiRecipes
+  class Configuration
+
+    def endpoints_configs=(configs = {})
+      raise ArgumentError, 'endpoints_configs must be an Hash' unless configs.is_a? Hash
+      @endpoints_configs = configs.deep_symbolize_keys
+    end
+
+    def endpoints_configs
+      unless @endpoints_configs
+        @endpoints_configs = {}
+      end
+      @endpoints_configs
+    end
+  end
+end

data/lib/api_recipes/endpoint.rb

@@ -0,0 +1,24 @@
+module ApiRecipes
+  class Endpoint
+
+    attr_accessor :name, :settings, :authorization, :basic_auth
+    attr_reader :resources
+
+    def initialize(name, config)
+      @name = name
+      @config = config
+      @settings = ApiRecipes::Settings::DEFAULT.merge config.endpoints_configs[name]
+
+      # Generate   some_endpoint.some_resource  methods
+      # e.g.  github.users
+      @resources = [] unless @resources
+      @settings[:routes].each do |resource, routes|
+        @resources << resource
+        res = Resource.new resource, self, routes
+        define_singleton_method resource do
+          res
+        end
+      end
+    end
+  end
+end

data/lib/api_recipes/exceptions.rb

@@ -0,0 +1,65 @@
+module ApiRecipes
+  class RouteNameClashError < Exception
+    def initialize(message = nil, route = nil, resource = nil)
+      if message
+        # Nothing to do
+      elsif route
+        message = "route name (#{route}) can't be equal to resource name (#{resource}). Please change route or resource name."
+      else
+        message = "route name can't be equal to resource name. Please change route or resource names."
+      end
+      super(message)
+    end
+  end
+
+  class MissingRouteAttribute < Exception
+    def initialize(message = nil, resource = nil, route = nil,  attribute = nil)
+      if message
+        # Nothing to do
+      elsif route && attribute
+        message = "route '#{resource}.#{route}' requires '#{attribute}' attribute but this was not given"
+      end
+      super(message)
+    end
+  end
+
+  class ResponseCodeNotAsExpected < Exception
+    def initialize(message = nil, resource = nil, route = nil, expected_code = nil, actual_code = nil, reason = nil)
+      if message
+        # Nothing to do
+      else
+        message = "response code for request on route '#{resource}.#{route}' has returned #{actual_code}, but #{expected_code} was expected. Reason: #{reason}"
+      end
+      super(message)
+    end
+  end
+
+  class EndpointConfigIsNotAnHash < Exception
+    def initialize(message = nil, endpoint = nil)
+      if message
+        # Nothing to do
+      else
+        message = "provided config for endpoint '#{endpoint}' must be an Hash"
+      end
+      super(message)
+    end
+  end
+
+  class NoConfigurationGivenForEndpoint < Exception
+    def initialize(message = nil, endpoint = nil)
+      if message
+        # Nothing to do
+      else
+        message = "no configuration provided for endpoint '#{endpoint}'"
+      end
+      super(message)
+    end
+  end
+
+  class RouteNameClashWithExistentMethod < Exception
+    def initialize(resource, route)
+      message = "can't define route '#{route}' method in resource '#{resource}' because method '#{route}' already exists"
+      super(message)
+    end
+  end
+end

data/lib/api_recipes/resource.rb

@@ -0,0 +1,151 @@
+module ApiRecipes
+  class Resource
+
+    attr_accessor :authorization, :basic_auth
+
+    def initialize(name, endpoint, routes = {})
+      @name = name
+      @routes = routes
+      @endpoint = endpoint
+
+      generate_routes
+    end
+
+    private
+
+    def build_path(route_name, route_attributes, provided_params)
+      path = route_attributes[:path] || ''
+
+      required_params_for_path(path).each do |rp|
+        unless p = provided_params.delete(rp)
+          raise MissingRouteAttribute.new(@name, route_name, rp)
+        end
+        path.gsub! ":#{rp}", p.to_s
+      end
+      path = "#{settings[:base_path]}#{settings[:api_version]}/#{@name}#{path}"
+      return path, provided_params
+    end
+
+    def build_request
+      request_with_auth
+          .headers(extract_headers)
+          .timeout :global,
+                   write: per_kind_timeout,
+                   connect: per_kind_timeout,
+                   read: per_kind_timeout
+    end
+
+    def build_uri_from(path)
+      attrs = {
+          scheme: settings[:protocol],
+          host: settings[:host],
+          port: port,
+          path: path
+      }
+      URI::Generic.build attrs
+    end
+
+    def check_response_code(route, route_attributes, response)
+      # Check if :ok_code is present, check the response
+      if ok_code = route_attributes[:ok_code]
+        code = response.code
+        # If the code does not match, apply the requested strategy (see FAIL_OPTIONS)
+        unless code == ok_code
+          case settings[:on_nok_code]
+            when :do_nothing
+            when :raise
+              raise ResponseCodeNotAsExpected.new(nil, @name, route, ok_code, code, response.body)
+            when :return_false
+              return false
+          end
+        end
+      end
+    end
+
+    def extract_headers
+      settings[:default_headers] || {}
+    end
+
+    # Generate routes  some_endpoint.some_resource.some_route  methods
+    # e.g. webapp.alarms.index
+    def generate_routes
+      @routes.each do |route, attrs|
+        if route.eql? @name
+          raise RouteNameClashError.new(route, @name)
+        end
+        unless respond_to? route.to_sym
+          define_singleton_method route.to_sym do |*params, &block|
+            start_request route, attrs, *params, &block
+          end
+        else
+          raise RouteNameClashWithExistentMethod.new(@name, route)
+        end
+      end
+      self
+    end
+
+    def per_kind_timeout
+      settings.fetch(:timeout, ApiRecipes::Settings::GLOBAL_TIMEOUT)/3.0
+    end
+
+    def port
+      settings[:port] || case settings[:protocol]
+                            when 'http'
+                              80
+                            when 'https'
+                              443
+                          end
+    end
+
+    def request
+      HTTP
+    end
+
+    def request_with_auth
+      req = request
+      if basic_auth
+        req = req.basic_auth basic_auth
+      elsif ba = @endpoint.basic_auth
+        req = req.basic_auth ba
+      end
+      if authorization
+        req = req.auth authorization
+      elsif auth = @endpoint.authorization
+        req = req.auth auth
+      end
+      req
+    end
+
+    def required_params_for_path(path)
+      path.scan(/:(\w+)/).flatten.map &:to_sym
+    end
+
+    def settings
+      @endpoint.settings
+    end
+
+    def start_request(route, route_attributes, *pars)
+      unless route_attributes
+        route_attributes = {}
+      end
+      unless method = route_attributes[:method]
+        method = Settings::DEFAULT_HTTP_VERB
+      end
+
+      params = pars.extract_options!
+      path, residual_params = build_path(route, route_attributes, params)
+      residual_params = nil unless residual_params.any?
+      uri = build_uri_from path
+
+      response = build_request.send(method.downcase, uri, json: residual_params)
+      check_response_code route, route_attributes, response
+
+      if block_given?
+        body = JSON.load response.body.to_s
+        yield body, response.code, response.reason
+      else
+        response
+      end
+    end
+  end
+end

data/lib/api_recipes/settings.rb

@@ -0,0 +1,19 @@
+module ApiRecipes
+  module Settings
+    GLOBAL_TIMEOUT = 1
+    FAIL_OPTIONS = [:return, :raise, :return_false]
+
+    DEFAULT = {
+        protocol: 'http',
+        host: 'localhost',
+        port: nil,
+        base_path: '',
+        api_version: '',
+        timeout: 3,
+        on_nok_code: :raise,
+        routes: {}
+    }
+
+    DEFAULT_HTTP_VERB = :get
+  end
+end

data/lib/api_recipes/version.rb

@@ -0,0 +1,3 @@
+module ApiRecipes
+  VERSION = '0.0.1'
+end

data/lib/api_recipes.rb

@@ -0,0 +1,90 @@
+require 'http'
+require 'oj'
+require 'oj_mimic_json'
+require 'active_support/core_ext/hash/indifferent_access'
+require 'active_support/core_ext/hash/keys'
+require 'active_support/core_ext/array/extract_options'
+
+require 'api_recipes/exceptions'
+require 'api_recipes/configuration'
+require 'api_recipes/resource'
+require 'api_recipes/endpoint'
+require 'api_recipes/settings'
+
+module ApiRecipes
+
+  def self.included(base)
+    base.send :include, InstanceAndClassMethods
+    base.extend ClassMethods
+    base.extend InstanceAndClassMethods
+  end
+
+  class << self
+    attr_accessor :configuration
+  end
+
+  def self.configuration
+    unless @configuration
+      @configuration = Configuration.new
+    end
+    @configuration
+  end
+
+  def self.configure
+    if block_given?
+      yield(configuration)
+    else
+      configuration
+    end
+  end
+
+  module ClassMethods
+    def endpoint(name, configs = {})
+      configs = configs.deep_symbolize_keys
+      name = name.to_sym
+
+      ep = Endpoint.new(name, merge_endpoints_configs(name, configs))
+      # Define 'name' method for the class
+      define_class_endpoint ep
+      # Define 'name' method for the class' instances
+      define_instance_endpoint ep
+    end
+
+    private
+
+    def define_class_endpoint(ep)
+      name = ep.name
+      unless method_defined? name
+        Thread.current[name] = ep
+
+        define_singleton_method name do
+          Thread.current[name]
+        end
+      end
+    end
+
+    def define_instance_endpoint(ep)
+      name = ep.name
+      send :define_method, name do
+        Thread.current[name].clone
+      end
+    end
+  end
+
+  module InstanceAndClassMethods
+
+    private
+
+    def merge_endpoints_configs(endpoint, configs)
+      if configs && !configs.is_a?(Hash)
+        raise EndpointConfigIsNotAnHash.new(endpoint)
+      end
+      unless ApiRecipes.configuration.endpoints_configs[endpoint]
+        ApiRecipes.configuration.endpoints_configs[endpoint] = {}
+      end
+      ApiRecipes.configuration.endpoints_configs[endpoint].merge! configs
+      ApiRecipes.configuration
+    end
+  end
+end
+

metadata

@@ -0,0 +1,127 @@
+--- !ruby/object:Gem::Specification
+name: api_recipes
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Alessandro Verlato
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-12-18 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: oj
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.13.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.13.0
+- !ruby/object:Gem::Dependency
+  name: oj_mimic_json
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.0.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.0.1
+- !ruby/object:Gem::Dependency
+  name: http
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.9.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.9.0
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 4.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 4.0.0
+description: 
+email:
+- averlato@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- .travis.yml
+- CODE_OF_CONDUCT.md
+- Gemfile
+- Guardfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- api_recipes.gemspec
+- bin/console
+- bin/setup
+- examples/authorization.rb
+- examples/authorization_with_default_headers.rb
+- examples/basic_auth.rb
+- examples/config/apis.yml
+- examples/custom_configs.rb
+- examples/delete_me.rb
+- examples/multiple_endpoints.rb
+- examples/simple_usage.rb
+- lib/api_recipes.rb
+- lib/api_recipes/configuration.rb
+- lib/api_recipes/endpoint.rb
+- lib/api_recipes/exceptions.rb
+- lib/api_recipes/resource.rb
+- lib/api_recipes/settings.rb
+- lib/api_recipes/version.rb
+homepage: https://github.com/madAle/api_recipes
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: 1.9.3
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.8
+signing_key: 
+specification_version: 4
+summary: Consume HTTP APIs with style
+test_files: []