callapi 0.8

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 930672be83fc5e7372fac0d6564fe7572f5cad79
+  data.tar.gz: a1a0d70c85b40f9b520e58a01174d22e6ba544fe
+SHA512:
+  metadata.gz: 1af1b261ec7d87ac3a2fd1fa56041dbf1867992e47bbbdf8a8c4a456b97c964f1ef9f0e3106ff5cce5e14ade0302978a881d2ebd02b836ec931df53f5e5c3ca8
+  data.tar.gz: 64dcba1a07560ade4d23178f1155a74719aefbce7e75f92b4eda928280773dbda0b1919f830679aae3854cbe1ccc1c6673905c027e5d6ff0e62a4a9217ac67e4

data/.gitignore

@@ -0,0 +1,7 @@
+/Gemfile.lock
+/tmp/
+*.bundle
+.idea
+.rspec
+.ruby-version
+*.gem

data/Gemfile

@@ -0,0 +1,16 @@
+source 'https://rubygems.org'
+
+gem 'multi_json'
+gem 'memoist'
+gem 'activesupport'
+gem 'addressable'
+gem 'addressabler', '>= 0.1'
+gem 'colorize'
+gem 'chainy', '~> 0.0.5'
+
+gemspec
+
+group :test do
+  gem 'rspec', '~> 3.1'
+  gem 'webmock'
+end

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Kacper Walanus
+
+MIT License
+
+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,207 @@
+# Callapi
+
+Easy API calls
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'callapi'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install callapi
+
+<br>
+## Usage
+
+### Basics
+
+##### 1 Configuration: Set your API host
+```ruby
+require 'callapi'
+
+Callapi::Config.configure do |config|
+  config.api_host = 'http://private-50e9-callapi.apiary-mock.com'
+end
+```
+  
+<br>
+##### 2 Routes: set your calls
+```ruby
+Callapi::Routes.draw do
+  get 'notes'       # This creates #get_notes_call method
+  get 'notes/:id'   # This creates #get_notes_by_id_call method
+  post 'notes'      # This creates #post_notes_call method
+end
+```
+
+<br>
+##### 3 Use your calls: #data and #body methods
+```ruby
+# Parsed response (default parser is Callapi::Call::Parser::Json, see Parsers section):
+get_notes_call.response.data    #=> [{"id"=>1, "title"=>"Jogging in park"}, {"id"=>2, "title"=>"Pick-up posters from post-office"}]
+
+# Raw response:
+get_notes_call.response.body    #=> '[{"id":1,"title":"Jogging in park"},{"id":2,"title":"Pick-up posters from post-office"}]'
+
+# Request with params:
+post_notes_call({id: 1, title: "Swimming"})
+```
+
+<br>
+### Routes
+
+##### HTTP methods
+```ruby
+Callapi::Routes.draw do
+  get 'results'     #=> #get_results_call
+  post 'results'    #=> #post_results_call
+  put 'results'     #=> #put_results_call
+  patch 'results'   #=> #patch_results_call
+  delete 'results'  #=> #delete_results_call
+end
+```
+
+<br>
+##### Params
+```ruby
+Callapi::Routes.draw do
+  get 'users/:id'                 #=> #get_users_by_id_call(id: 109) | :id is required
+  put 'users/:id'                 #=> #put_users_by_id_call(id: 109, name: 'Kacper', age: 467)
+  put 'users/:id/posts/:post_id'  #=> #put_users_by_id_posts_by_post_id_call(id: 109, post_id: 209)
+end
+```
+
+<br>
+##### Namespaces
+```ruby
+Callapi::Routes.draw do
+  get 'users'               #=> #get_users_call
+  
+  namespace 'users' do
+    get ':id'               #=> #get_users_by_id_call(id: 109)
+    delete ':id'            #=> #delete_users_by_id_call(id: 109)
+  end
+  
+  namespace 'users/:id/posts' do
+    get ':post_id'          #=> #get_users_by_id_posts_by_post_id_call(id: 109, post_id: 209)
+  end
+end
+```
+
+<br>
+##### Options
+```ruby
+Callapi::Routes.draw do
+  get 'users', parser: Callapi::Call::Parser::Json
+end
+```
+
+<br>
+## Parsers
+
+##### Available parsers
+Callapi provides following parsers:
+- `Callapi::Call::Parser::Json`
+- `Callapi::Call::Parser::Json::AsObject`
+- `Callapi::Call::Parser::Plain`
+
+Default is `Callapi::Call::Parser::Json`. 
+
+<br>
+__`Callapi::Call::Parser::Json`__ converts JSON to `Hash`. If the API response for `/notes/12` is 
+
+```javascript
+{ "id": 2, "title": "Pick-up posters from post-office" }
+```
+
+then with `#data` method we can convert this response to `Hash`:
+```ruby
+get_notes_by_id_call(id: 12).response.data['id']  #=> 2
+```
+
+<br>
+__`Callapi::Call::Parser::Json::AsObject`__ converts JSON to an object called `DeepStruct` (very similar to [`OpenStruct`](http://www.ruby-doc.org/stdlib-2.0/libdoc/ostruct/rdoc/OpenStruct.html)):
+```ruby
+get_notes_by_id_call(id: 12).response.data.title  #=> "Pick-up posters from post-office"
+```
+
+<br>
+__`Callapi::Call::Parser::Plain`__ does not parse at all:
+```ruby
+get_notes_by_id_call(id: 12).response.data  #=> '{ "id": 2, "title": "Pick-up posters from post-office" }'
+```
+
+<br>
+##### Setting parsers
+Default parser for all calls can be set in configuration:
+```ruby
+Callapi::Config.configure do |config|
+  config.default_response_parser = Callapi::Call::Parser::Json::AsObject
+end
+```
+
+Default parser for specific calls can be set in routes:
+```ruby
+Callapi::Routes.draw do
+  get 'users', parser: Callapi::Call::Parser::Json::AsObject
+  get 'version', parser: Callapi::Call::Parser::Plain
+end
+```
+
+Parser can be also set for each call instance separately:
+```ruby
+get_notes_call.with_response_parser(Callapi::Call::Parser::Json::AsObject).response.data    #=> [#<DeepStruct id=1, title="Jogging in park">]
+get_notes_call.with_response_parser(Callapi::Call::Parser::Plain).response.data             #=> "[{\n  \"id\": 1, \"title\": \"Jogging in park\"\n}]"
+
+call = get_notes_call
+call.with_response_parser(Callapi::Call::Parser::Json::AsObject).response.data  #=> [#<DeepStruct id=1, title="Jogging in park">]
+call.reload # DO NOT FORGET TO CLEAR CACHE!
+call.with_response_parser(Callapi::Call::Parser::Plain).response.data           #=> "[{\n  \"id\": 1, \"title\": \"Jogging in park\"\n}]"
+```
+ 
+<br>
+## Configuration
+
+##### Config options
+
+- `api_host`
+- `api_path_prefix`
+- `default_response_parser`
+- `log_level`
+
+```ruby
+Callapi::Config.configure do |config|
+  config.api_host = 'http://your.api.org'
+  
+  # request will be send to http://your.api.org/api/
+  config.api_path_prefix = 'api'
+  
+  # see Parsers section
+  config.default_response_parser = Callapi::Call::Parser::Json::AsObject
+  
+  # :none is only possible option. turns off logs.
+  config.log_level = :none
+end
+```
+
+<br>
+## TO DO
+
+- Support HTTPS
+
+<br>
+## Contributing
+
+1. Fork it ( https://github.com/[my-github-username]/callapi/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request

data/Rakefile

@@ -0,0 +1,2 @@
+require "bundler/gem_tasks"
+

data/callapi.gemspec

@@ -0,0 +1,31 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'callapi/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "callapi"
+  spec.version       = Callapi::VERSION
+  spec.authors       = ["Kacper Walanus"]
+  spec.email         = ["kacper.walanus@elpassion.pl"]
+  spec.summary       = %q{Callapi}
+  spec.description   = %q{Callapi}
+  spec.homepage      = ""
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency 'bundler', '~> 1.7'
+  spec.add_development_dependency 'rake', '~> 10.0'
+
+  spec.add_runtime_dependency 'addressable', '~> 2.3'
+  spec.add_runtime_dependency 'addressabler', '~> 0.1'
+  spec.add_runtime_dependency 'multi_json', '~> 1.10'
+  spec.add_runtime_dependency 'colorize', '~> 0.7'
+  spec.add_runtime_dependency 'activesupport', '~> 4.2'
+  spec.add_runtime_dependency 'chainy', '~> 0.0.5'
+  spec.add_runtime_dependency 'memoist', '~> 0.11'
+end

data/lib/callapi.rb

@@ -0,0 +1,12 @@
+require 'callapi/version'
+require 'memoist'
+require 'forwardable'
+require 'chainy'
+require 'ostruct'
+
+module Callapi
+  require 'callapi/config'
+  require 'callapi/errors'
+  require 'callapi/call'
+  require 'callapi/routes'
+end

data/lib/callapi/call.rb

@@ -0,0 +1,3 @@
+module Callapi::Call
+  require_relative 'call/base'
+end

data/lib/callapi/call/base.rb

@@ -0,0 +1,66 @@
+require_relative 'request_metadata'
+
+class Callapi::Call::Base
+  require_relative 'request'
+  require_relative 'response'
+
+  extend Forwardable
+  extend Memoist
+
+  def_delegators :request_metadata, :request_method, :request_path
+
+  chain_attr_accessor :params, :headers, hash: true, prefix: 'add'
+  chain_attr_accessor :response_parser, :strategy
+
+  def initialize(params = {})
+    add_params(params)
+  end
+
+  def response
+    @response ||= build_response
+  end
+
+  def strategy
+    @strategy ||= (self.class.strategy || Callapi::Config.default_request_strategy)
+  end
+
+  def request_metadata
+    Callapi::Call::RequestMetadata.new(self)
+  end
+  memoize :request_metadata
+
+  def response_parser
+    @response_parser ||= (self.class.response_parser || Callapi::Config.default_response_parser)
+  end
+
+  def self.strategy=(strategy)
+    @strategy = strategy
+  end
+
+  def self.strategy
+    @strategy
+  end
+
+  def self.response_parser=(response_parser)
+    @response_parser = response_parser
+  end
+
+  def self.response_parser
+    @response_parser
+  end
+
+  def reload
+    @response = nil
+  end
+
+  private
+
+  def build_response
+    response_parser.new(request_class.new(self).response)
+  end
+
+  #TODO: Should be replaced with #strategy. There is no need for additional class between Base and actual strategy, for now Callapi::Call::Request is such unnecessary class.
+  def request_class
+    Callapi::Call::Request
+  end
+end

data/lib/callapi/call/request.rb

@@ -0,0 +1,14 @@
+class Callapi::Call::Request
+  require_relative 'request/base'
+  require_relative 'request/http'
+  require_relative 'request/api'
+  require_relative 'request/mock'
+
+  def initialize(context)
+    @context = context
+  end
+
+  def response
+    @context.strategy.new(@context).response
+  end
+end

data/lib/callapi/call/request/api.rb

@@ -0,0 +1,9 @@
+class Callapi::Call::Request::Api < Callapi::Call::Request::Http
+  def host
+    Callapi::Config.api_host || raise(Callapi::ApiHostNotSetError)
+  end
+
+  def api_path_prefix
+    Callapi::Config.api_path_prefix
+  end
+end

data/lib/callapi/call/request/base.rb

@@ -0,0 +1,13 @@
+class Callapi::Call::Request::Base
+  extend Forwardable
+
+  def_delegators :@context, :request_method, :request_path, :params, :headers
+
+  def initialize(context)
+    @context = context
+  end
+
+  def response
+    raise NotImplementedError
+  end
+end

data/lib/callapi/call/request/http.rb

@@ -0,0 +1,60 @@
+require 'net/http'
+require 'addressable/uri'
+require 'addressabler'
+
+class Callapi::Call::Request::Http < Callapi::Call::Request::Base
+  require_relative 'http/log_helper'
+
+  extend Memoist
+  include Callapi::Call::Request::Http::LogHelper
+
+  HTTP_METHOD_TO_REQUEST_CLASS = {
+    get:     Net::HTTP::Get,
+    post:    Net::HTTP::Post,
+    put:     Net::HTTP::Put,
+    delete:  Net::HTTP::Delete,
+    patch:   Net::HTTP::Patch
+  }
+
+  def response
+    with_logging do
+      http.request(request)
+    end
+  end
+
+  private
+
+  def host
+    raise NotImplementedError
+  end
+
+  def http
+    Net::HTTP.new(uri.host, uri.port)
+  end
+
+  def request
+    request_class.new(uri.request_uri, headers).tap do |request|
+      request.set_form_data params if put_params_in_request_body?
+    end
+  end
+
+  def request_class
+    HTTP_METHOD_TO_REQUEST_CLASS[request_method] || raise(Callapi::UnknownHttpMethodError)
+  end
+
+  def uri
+    Addressable::URI.parse(host).tap do |uri|
+      uri.path = path_prefix + request_path
+      uri.query_hash = params unless put_params_in_request_body?
+    end
+  end
+  memoize :uri
+
+  def put_params_in_request_body?
+    [:post, :patch, :put].include? request_method
+  end
+
+  def path_prefix
+    ''
+  end
+end