rest-service-client 0.1.3

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 17f91adee05d2bc1fcc439e5d6b4efd3b6f85ed7
+  data.tar.gz: aad2cfb5854b352b654ee2c7cadb498210647043
+SHA512:
+  metadata.gz: 298a23c415c2f7ca179294a68b83166a6ba5ae19c6e217ea8960e5335caa4b920fbcaa741681ee01cfbf26e9d58306b2f6531c4b665c6adb82c89f605fddf984
+  data.tar.gz: f7834c58f22fefe16b13b403a040949622162890300fdb7cbaf13750bfade6ca11e32ba824694140fe43c880223c2d97886fea3d39dd26a855ba951258918090

data/.gitignore

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

data/.ruby-gemset

@@ -0,0 +1 @@
+service_client

data/.ruby-version

@@ -0,0 +1 @@
+ruby-2.4.1

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.4.1
+before_install: gem install bundler -v 1.15.3

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+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, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at gravisbesya@list.ru. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
+
+git_source(:github) { |repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in rest-service-client.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 Igor Bespalov
+
+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,236 @@
+# ServiceClient
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'rest-service-client'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install service-client
+
+## Usage
+Add this line to top of your file
+```ruby
+require 'rest-service-client'
+````
+
+Create a class, include the RestServiceClient and configure your service
+```ruby
+class MyAwesomeService
+    include RestServiceClient
+  
+    # Sets the host url
+    # You can use MyAwesomeService.new('https://jsonplaceholder.typicode.com')
+    # to set the host instead. Using host url via constructor has high priority.
+    host 'https://jsonplaceholder.typicode.com'
+
+    # Sets the default headers for every requests.
+    # Will be replaced using: MyAwesomeService.new.find_photo(id: 1, headers: { 'Authorization' => 'Bearer 123456' })
+    headers 'Authorization' => 'OAuth 1111|111'
+
+    # Sets the default params for every requests.
+    # Will be replaced using: MyAwesomeService.new.find_photo(id: 20)
+    params id: 10
+
+    # Configure endpoints:
+    # _httpmethod _method_name, _path
+    # "get :photos, '/photos'" provides an ability 
+    # to make GET request to 'https://jsonplaceholder.typicode.com/photos'
+    # using MyAwesomeService.new.photos
+    # Supported: get, post, put, patch, delete
+    get :photos, '/photos'
+    
+    # You can assign placeholders for params to path.
+    # Example: MyAwesomeService.new.find_photo(id: 1)
+    get :find_photo, '/photos/:id'
+    
+    post :add_photo, '/photos'
+    put :update_photo, '/photos/:id'
+    patch :update_photo_data, '/photos/:id'
+    delete :delete_photo, '/photos/:id'
+end
+```
+
+## Samples
+
+### Simple Service
+```ruby
+class SimpleService
+  include RestServiceClient
+  
+  host 'https://jsonplaceholder.typicode.com'
+  
+  get :photo, '/photos/:id'
+  get :first_photo, '/photos/1'
+  get :second_photo, '/photos/2'
+end
+
+service = SimpleService.new
+
+p service.first_photo['id']
+# 1
+
+p service.second_photo['id']
+# 2
+
+p service.photo(id: 10)['id']
+# 10
+
+```
+
+### GET
+
+```ruby
+class SimpleService
+  include RestServiceClient
+  host 'https://jsonplaceholder.typicode.com'
+  get :photo, '/photos/:id', { id: 1 }
+end
+
+service = SimpleService.new
+p service.photo['id']         # 1
+p service.photo(id: 2)['id']  # 2
+```
+
+```ruby
+class SimpleService
+  include RestServiceClient
+  host 'https://jsonplaceholder.typicode.com'
+  
+  get :first_photo, '/photos/1', {}, { Authentication: 'my-token' }
+end
+
+service = SimpleService.new
+# Sends the request to 'https://jsonplaceholder.typicode.com/photos/1'
+# includes Headers: { 'Authentication': 'my-token' }
+p service.first_photo['albumId'] # 1
+
+# Sends the request to 'https://jsonplaceholder.typicode.com/photos/1'
+# includes Headers: { 
+#   'Authentication': 'my-token',
+#   'AnotherHeaderKey': 'AnotherHeaderValue' 
+# }
+another_headers = { AnotherHeaderKey: 'AnotherHeaderValue' }
+photo = service.first_photo(headers: another_headers)
+p photo['albumId'] # 1
+
+```
+
+### DELETE
+```ruby
+class SimpleService
+  include RestServiceClient
+  host 'https://jsonplaceholder.typicode.com'
+  delete :delete_photo, '/photos/:id'
+end
+
+service = SimpleService.new
+service.delete_photo id: 1
+```
+
+### POST
+```ruby
+class SimpleService
+  include RestServiceClient
+  host 'https://jsonplaceholder.typicode.com'
+  post :add_photo, '/photos'
+end
+
+service = SimpleService.new
+photo = {
+    albumId: 1,
+    title: 'new photo',
+    url: 'http://placehold.it/600/92c952',
+    thumbnailUrl: 'http://placehold.it/150/92c952'
+}
+p service.add_photo payload: photo
+=begin
+{
+  "albumId"=>1,
+  "title"=>"new photo", 
+  "url"=>"http://placehold.it/600/92c952",
+  "thumbnailUrl"=>"http://placehold.it/150/92c952",
+  "id"=>5001
+}
+=end
+
+```
+
+
+### PATCH
+```ruby
+class SimpleService
+  include RestServiceClient
+  host 'https://jsonplaceholder.typicode.com'
+  patch :update_photo_data, '/photos/:id'
+end
+
+service = SimpleService.new
+updated_photo = service.update_photo_data id: 1, payload: { title: 'new title'}
+p updated_photo['title']
+# "new title"
+
+```
+
+## Debug mode
+
+You can debug mode on for see what is happening
+
+```ruby
+class SimpleService
+  include RestServiceClient
+  debug true
+  host 'https://jsonplaceholder.typicode.com'
+  headers key1: 'value1', 'key2': 'value2'
+  get :photo, '/photos/1'
+end
+
+service = SimpleService.new
+service.photo
+=begin
+ ______
+|
+|  SimpleService is processing GET request to https://jsonplaceholder.typicode.com/photos/1
+|    Headers: {:key1=>"value1", :key2=>"value2"}
+|    Payload: {}
+|
+|  SimpleService is processing the response on GET request to https://jsonplaceholder.typicode.com/photos/1
+|    Status: 200
+|    Body: {
+  "albumId": 1,
+  "id": 1,
+  "title": "accusamus beatae ad facilis cum similique qui sunt",
+  "url": "http://placehold.it/600/92c952",
+  "thumbnailUrl": "http://placehold.it/150/92c952"
+}
+|______
+=end
+
+```
+
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` 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/besya/rest-service-client. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://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).
+
+## Code of Conduct
+
+Everyone interacting in the ServiceClient project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/service_client/blob/master/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+require 'bundler/gem_tasks'
+require 'rake/testtask'
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'test'
+  t.libs << 'lib'
+  t.test_files = FileList['test/**/*_test.rb']
+end
+
+task default: :test

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require 'bundler/setup'
+require 'rest-service-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(__FILE__)

data/bin/setup

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

data/lib/rest-service-client.rb

@@ -0,0 +1,2 @@
+# More logical way to require 'rest-service-client'
+require File.dirname(__FILE__) + '/restserviceclient'

data/lib/rest_service_client.rb

@@ -0,0 +1,2 @@
+# This file exists for backward compatbility with require 'rest_service_client'
+require File.dirname(__FILE__) + '/restserviceclient'

data/lib/restserviceclient/version.rb

@@ -0,0 +1,7 @@
+module RestServiceClient
+  VERSION = '0.1.3'.freeze
+
+  def self.version
+    VERSION
+  end
+end

data/lib/restserviceclient.rb

@@ -0,0 +1,133 @@
+require 'rest-client'
+require 'json'
+
+module RestServiceClient
+  def self.included(base)
+    base.extend(ClassMethods)
+  end
+
+  attr_accessor :host,
+                :serializer,
+                :default_headers,
+                :default_params,
+                :debug
+
+  def initialize(url = nil, serializer = nil, debug = nil)
+    @host = url unless url.nil?
+    @host = get_host if respond_to?(:get_host) && url.nil?
+
+    @serializer = JsonSerializer
+    @serializer = serializer unless serializer.nil?
+    @serializer = get_serializer if respond_to?(:get_serializer) && serializer.nil?
+
+    @debug = false
+    @debug = debug unless debug.nil?
+    @debug = get_debug if respond_to?(:get_debug) && debug.nil?
+
+    @default_headers = {}
+    @default_params = {}
+
+    @default_headers = get_default_headers if respond_to? :get_default_headers
+    @default_params = get_default_params if respond_to? :get_default_params
+  end
+
+  def make_request(http_method, endpoint, payload = {}, headers = {})
+    case http_method
+      when :get then  RestClient.get(endpoint, headers)
+      when :post then RestClient.post(endpoint, payload, headers)
+      when :put then RestClient.put(endpoint, payload, headers)
+      when :patch then RestClient.patch(endpoint, payload, headers)
+      when :delete then RestClient.delete(endpoint)
+      else throw Exception.new("Method #{http_method} doesn't supported.")
+    end
+  end
+  private :make_request
+
+  module ClassMethods
+    def host(url)
+      define_method :get_host, &-> { url }
+    end
+
+    def serializer(serializer_class)
+      define_method :get_serializer, &-> { serializer_class }
+    end
+
+    def headers(default_headers)
+      define_method :get_default_headers, &-> { default_headers }
+    end
+
+    def params(default_params)
+      define_method :get_default_params, &-> { default_params }
+    end
+
+    def debug(flag)
+      define_method :get_debug, &-> { flag }
+    end
+
+    def get(method_name, path = '', default_params = {}, default_headers = {}, default_payload = {})
+      add_method :get, method_name, path, default_params, default_headers, default_payload
+    end
+
+    def post(method_name, path = '', default_params = {}, default_headers = {}, default_payload = {})
+      add_method :post, method_name, path, default_params, default_headers, default_payload
+    end
+
+    def put(method_name, path = '', default_params = {}, default_headers = {}, default_payload = {})
+      add_method :put, method_name, path, default_params, default_headers, default_payload
+    end
+
+    def patch(method_name, path = '', default_params = {}, default_headers = {}, default_payload = {})
+      add_method :patch, method_name, path, default_params, default_headers, default_payload
+    end
+
+    def delete(method_name, path = '', default_params = {}, default_headers = {}, default_payload = {})
+      add_method :delete, method_name, path, default_params, default_headers, default_payload
+    end
+
+    private
+
+    def add_method(http_method, method_name, path, default_params, default_headers, default_payload)
+      define_method method_name do |headers: {}, payload: {}, parameters: {}, **params|
+        params = @default_params.merge(default_params.merge(params.merge(parameters)))
+        headers = @default_headers.merge(default_headers.merge(headers))
+        payload = default_payload.merge payload
+
+        uri = path.clone
+
+        params.each_with_object(uri) do |(k, v), p|
+          p.sub! ":#{k}", v.to_s
+        end
+
+        endpoint = @host + uri
+
+        if @debug
+          puts
+          puts ' ______'
+          puts '|'
+          puts "|  #{self.class.name} is processing #{http_method.upcase} request to #{endpoint}"
+          puts "|    Headers: #{headers}"
+          puts "|    Payload: #{payload}"
+        end
+
+        response = make_request http_method, endpoint, payload, headers
+
+        if @debug
+          puts '|'
+          puts "|  #{self.class.name} is processing the response on #{http_method.upcase} request to #{endpoint}"
+          puts "|    Status: #{response.code}"
+          puts "|    Body: #{response.body}"
+          puts '|______'
+          puts
+        end
+
+        @serializer.deserialize(response.body)
+      end
+    end
+  end
+
+  class JsonSerializer
+    def self.deserialize(data)
+      JSON.parse(data)
+    end
+  end
+end

data/rest-service-client.gemspec

@@ -0,0 +1,31 @@
+# coding: utf-8
+# frozen_string_literal: true
+
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require File.dirname(__FILE__) + '/lib/restserviceclient/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'rest-service-client'
+  spec.version       = RestServiceClient::VERSION
+  spec.authors       = ['Igor Bespalov']
+  spec.email         = ['gravisbesya@list.ru']
+
+  spec.summary       = 'DSL for rest-client'
+  spec.homepage      = 'https://github.com/besya/rest-service-client'
+  spec.license       = 'MIT'
+
+  spec.files = `git ls-files -z`.split("\0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.bindir        = 'exe'
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  spec.add_development_dependency 'bundler', '~> 1.15'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'minitest', '~> 5.0'
+
+  spec.add_dependency 'rest-client'
+  spec.add_dependency 'json'
+end

metadata

@@ -0,0 +1,130 @@
+--- !ruby/object:Gem::Specification
+name: rest-service-client
+version: !ruby/object:Gem::Version
+  version: 0.1.3
+platform: ruby
+authors:
+- Igor Bespalov
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2017-08-18 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.15'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.15'
+- !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: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+- !ruby/object:Gem::Dependency
+  name: rest-client
+  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: json
+  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'
+description: 
+email:
+- gravisbesya@list.ru
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".ruby-gemset"
+- ".ruby-version"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/rest-service-client.rb
+- lib/rest_service_client.rb
+- lib/restserviceclient.rb
+- lib/restserviceclient/version.rb
+- rest-service-client.gemspec
+homepage: https://github.com/besya/rest-service-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.6.12
+signing_key: 
+specification_version: 4
+summary: DSL for rest-client
+test_files: []