rest-api-client 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 4362dca96fd11280131e0db43bb36aca549c118d
+  data.tar.gz: d6f0dcddcca97eafcf0c98ff8ecf563f0d35f3e1
+SHA512:
+  metadata.gz: ad0493709c322a34d167c72741c1df4eae1042e4ef602fe3d0d9599d0587b9d7ab73dbc1e23292a6f24f761a5b9a0addaa96636b8f8ca8b875fd3a696dda5970
+  data.tar.gz: 6d3133951d53dafc8b9a5d1d0a61a3ace4f1a2d4d4f92a3d1142594a62feefc7220437cbce07e824323932aaf161f29d6ffae109b2a8ac970ddbd8415d0fb83e

data/.gitignore

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

data/.rspec

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

data/.travis.yml

@@ -0,0 +1,3 @@
+language: ruby
+rvm:
+  - 2.2.1

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in rest-api-client.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 Victor
+
+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,39 @@
+# RestApiClient
+[![Build Status](https://travis-ci.org/victor0402/rest-api-client.svg?branch=master)](https://travis-ci.org/victor0402/rest-api-client)
+
+Common classes and methods to handle rest communication
+
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'rest-api-client'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install rest-api-client
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, 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` to create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+1. Fork it ( https://github.com/victor0402/rest-api-client/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,7 @@
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new
+
+task :default => :spec
+task :test => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "rest/api/client"
+
+# 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/lib/rest/api/client/config.rb

@@ -0,0 +1,32 @@
+require 'yaml'
+
+module RestApiClient
+
+  # Configuration defaults
+  @config = {
+      :log_level => 'verbose',
+      :service_key => ''
+  }
+
+  # Configure through hash
+  def self.configure(opts = {})
+    opts.each { |k, v| @config[k.to_sym] = v }
+  end
+
+  # Configure through yaml file
+  def self.configure_with(path_to_yaml_file)
+    begin
+      config = YAML::load(IO.read(path_to_yaml_file))
+    rescue Errno::ENOENT
+      log(:warning, "YAML configuration file couldn't be found. Using defaults."); return
+    rescue Psych::SyntaxError
+      log(:warning, 'YAML configuration file contains invalid syntax. Using defaults.'); return
+    end
+
+    configure(config)
+  end
+
+  def self.config
+    @config
+  end
+end

data/lib/rest/api/client/json_parser.rb

@@ -0,0 +1,26 @@
+require 'json'
+
+module RestApiClient
+
+  def self.parse_json(json, opts = {})
+    json_response = JSON.parse json
+
+    data_type = opts[:type]
+
+    json_data = {}
+    if json_response.kind_of?(Hash) && json_response.has_key?('data')
+      json_data = json_response['data']
+    end
+
+    if json_data.kind_of?(Array) && data_type
+      return json_data.map { |data| data_type.new data }
+    elsif json_data.kind_of?(Hash) && data_type
+      return data_type.new json_data
+    else
+      return json_data unless json_data.empty?
+    end
+
+    json_response
+  end
+
+end

data/lib/rest/api/client/request_handler.rb

@@ -0,0 +1,55 @@
+require 'rest-client'
+require 'json'
+require 'redis'
+
+module RestApiClient
+
+  class RequestsHandler
+
+    def self.perform_get(service_key, path, args = {:params => {}})
+      RestClient.get(get_service_url(service_key) + path, args[:params]) { |response, request, result, &block|
+        get_response_callback(args).call(response, request, result, &block)
+      }
+    end
+
+    def self.perform_post(service_key, path, args = {})
+      RestClient.post(get_service_url(service_key) + path, args[:params]) { |response, request, result, &block|
+        get_response_callback(args).call(response, request, result, &block)
+      }
+    end
+
+    def self.perform_put(service_key, path, args = {})
+      RestClient.put(get_service_url(service_key) + path, args[:params]) { |response, request, result, &block|
+        get_response_callback(args).call(response, request, result, &block)
+      }
+    end
+
+    def self.perform_delete(service_key, path, args = {})
+      RestClient.delete(get_service_url(service_key) + path, args[:params]) { |response, request, result, &block|
+        get_response_callback(args).call(response, request, result, &block)
+      }
+    end
+
+    def self.get_service_url(service_key)
+      redis = Redis.new
+      path = redis.get service_key
+      raise RestApiClient::ServiceUrlException.new('You must need to set the service key') unless path
+      path << '/' unless path.end_with?('/')
+      path
+    end
+
+    def self.get_response_callback(args)
+      lambda do |response, request, result, &block|
+        if response.code >= 200 && response.code < 300
+          RestApiClient.parse_json response, args
+
+        elsif [301, 302, 307].include? response.code
+          response.follow_redirection(request, result, &block)
+
+        else
+          response.return!(request, result, &block)
+        end
+      end
+    end
+  end
+end

data/lib/rest/api/client/version.rb

@@ -0,0 +1,3 @@
+module RestApiClient
+  VERSION = '0.1.0'
+end

data/lib/rest/api/client.rb

@@ -0,0 +1,90 @@
+require 'virtus'
+require 'rest/api/client/version'
+require 'rest/api/client/json_parser'
+require 'rest/api/client/config'
+require 'rest/api/exceptions/service_url_exception'
+require 'rest/api/client/request_handler'
+
+module RestApiClient
+
+  class RestModel
+    include Virtus.model
+
+    PATH = ''
+    SERVICE_KEY = ''
+
+    attribute :id, Integer
+    attribute :created_at, Date
+    attribute :updated_at, Date
+
+    def self.list
+      perform_get path, {:type => self}
+    end
+
+    def self.find(id)
+      perform_get "#{path}/#{id}", {:type => self}
+    end
+
+    def self.get(id)
+      self.find id
+    end
+
+    def save!
+      perform_post path, {:type => self, :params => self.attributes}
+    end
+
+    def delete
+      perform_delete "#{path}/#{id}"
+    end
+
+    def update!
+      perform_put "#{path}/#{id}", {:type => self, :params => self.attributes}
+    end
+
+    def perform_get(path, args = {})
+      RequestsHandler.perform_get(service_key, path, args)
+    end
+
+    def perform_post(path, args = {})
+      RequestsHandler.perform_post(service_key, path, args)
+    end
+
+    def perform_put(path, args = {})
+      RequestsHandler.perform_put(service_key, path, args)
+    end
+
+    def perform_delete(path, args = {})
+      RequestsHandler.perform_delete(service_key, path, args)
+    end
+
+    def self.perform_get(path, args = {})
+      RequestsHandler.perform_get(service_key, path, args)
+    end
+
+    # default service_key to instance methods
+    def service_key
+      SERVICE_KEY
+    end
+
+    # default service_key to class methods
+    def self.service_key
+      SERVICE_KEY
+    end
+
+    # default path to instance methods
+    def path
+      PATH
+    end
+
+    # default path to class methods
+    def self.path
+      PATH
+    end
+
+    def ==(other)
+      id == other.id
+    end
+
+  end
+
+end

data/lib/rest/api/exceptions/service_url_exception.rb

@@ -0,0 +1,4 @@
+module RestApiClient
+  class ServiceUrlException < StandardError
+  end
+end

data/rest-api-client.gemspec

@@ -0,0 +1,32 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'rest/api/client/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'rest-api-client'
+  spec.version       = RestApiClient::VERSION
+  spec.authors       = ['Victor']
+  spec.email         = ['vcarvalho0402@gmail.com']
+
+  spec.summary       = 'rest-api-client'
+  spec.description   = 'Common classes and methods to handle rest communication'
+  spec.homepage      = 'https://github.com/victor0402/rest-api-client'
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = 'exe'
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  spec.add_runtime_dependency 'rest-client', '~> 1.8.0'
+  spec.add_runtime_dependency 'redis', '~> 3.2.1'
+  spec.add_runtime_dependency 'virtus'
+
+  spec.add_development_dependency 'bundler'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rspec', '~> 3.2.0'
+  spec.add_development_dependency 'factory_girl'
+  spec.add_development_dependency 'webmock'
+  spec.add_development_dependency 'simplecov'
+end

metadata

@@ -0,0 +1,186 @@
+--- !ruby/object:Gem::Specification
+name: rest-api-client
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Victor
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2015-06-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rest-client
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.8.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.8.0
+- !ruby/object:Gem::Dependency
+  name: redis
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.2.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.2.1
+- !ruby/object:Gem::Dependency
+  name: virtus
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.2.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.2.0
+- !ruby/object:Gem::Dependency
+  name: factory_girl
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Common classes and methods to handle rest communication
+email:
+- vcarvalho0402@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/rest/api/client.rb
+- lib/rest/api/client/config.rb
+- lib/rest/api/client/json_parser.rb
+- lib/rest/api/client/request_handler.rb
+- lib/rest/api/client/version.rb
+- lib/rest/api/exceptions/service_url_exception.rb
+- rest-api-client.gemspec
+homepage: https://github.com/victor0402/rest-api-client
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.7
+signing_key: 
+specification_version: 4
+summary: rest-api-client
+test_files: []