api_client_base 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: a47670c0ba3b9854d0b1fe79fff7b6c507770b02
+  data.tar.gz: ddbab067dc66987450d9784f95fceba9c819a71b
+SHA512:
+  metadata.gz: 17c4e3977db0ee463d9606c84b43a68c82ad7b32fed463a05348c1d99a7f54f1ef6e38206611b83b238d2e517272c98fe75375f62d8bf52c0ba9cb5f0ace32b1
+  data.tar.gz: 5ceaf0fcd18fd69a6ff01a0f555ce4f22bf669b35ba55afcd2c2cdcbcaeaa9390739a9f370fc145160cf71327240be29bef83d28525fe8c383056bdbdbd599ab

data/.gitignore

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

data/.rspec

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

data/.travis.yml

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

data/CHANGELOG.md

@@ -0,0 +1,9 @@
+# Change Log
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](http://keepachangelog.com/)
+and this project adheres to [Semantic Versioning](http://semver.org/).
+
+## [Unreleased]
+### Added
+- Initial release

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 ramon.tayag@gmail.com. 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,6 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in api_client_base.gemspec
+gemspec
+
+gem "pry-byebug"

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Ramon Tayag
+
+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,166 @@
+# APIClientBase
+
+Abstractions to help author API wrappers in Ruby.
+
+## Installation
+
+- Add `api_client_base` as a dependency to your gem's gemspec.
+- `require 'api_client_base'` in `lib/yourgem.rb`
+
+## Usage
+
+This gem assumes your gem will follow a certain structure.
+
+- Actions that your gem can perform are done through a class, like `APIWrapper::Client`.
+- Each action has request and response classes.
+  - Request class takes care of appending the endpoint's path to the host, preparing params, and specifying the right http method to call
+  - Response class takes care of parsing the response and making the data easily accessible for consumption.
+
+### Configuring the `Client`
+
+#### Default Options
+
+```ruby
+module MyGem
+  class Client
+    # specifying a symbol for `default_opts` will look for a method of that name
+    # and pass that into the request
+    HOST = "https://production.com"
+    include APIClientBase::Client.module(default_opts: :default_opts)
+
+    private
+
+    def default_opts
+      { host: HOST, secret: MyGem.configuration.secret }
+    end
+  end
+
+  class Client
+    # You may also give a hash directly
+    HOST = "https://production.com"
+    include APIClientBase::Client.module(default_opts: {host: HOST})
+  end
+end
+```
+
+#### Actions
+
+```ruby
+module MyGem
+  class Client
+    include APIClientBase::Client.module(default_opts: :all_opts)
+    api_action :get_user
+
+    # `api_action` basically creates a method like:
+    # def get_user(opts={})
+    #   request = GetUserRequest.new(all_opts.merge(opts))
+    #   raw_response = request.()
+    #   GetUserResponse.new(raw_response: raw_response)
+    # end
+
+    private
+
+    def all_opts
+      # At least include `host`. Other things you may need to include: `token`, `secret`
+      { host: "http://prod.com" }
+    end
+  end
+end
+```
+
+- `api_action` accepts the method name, and optional hash of arguments. These may contain:
+  - `args`: if not defined, the args expected by the method is nothing, or a hash. If given, it must be an array of symbols. For example, if `args: [:id, :name]` is given, then the method defined is effectively: `def my_action(id, name)` but what is passed into the request object is still `{id: "id-value", name: "name-value"}`
+
+You still need to create `MyGem::GetUserRequest` and `MyGem::GetUserResponse`. See the "requests" and "responses" section below.
+
+#### Requests
+
+```ruby
+module MyGem
+  class GetUserRequest
+    include APIClientBase::Request.module(
+      # you may define the action by `action: :post`. Defaults to `:get`.
+      # You may also opt to define `#default_action` (see below)
+    )
+
+    private
+
+    def path
+      "/api/v1/users/#{self.user_id}"
+    end
+
+    # Following methods are optional. Override them if you need to send something specific
+
+    def headers
+      {"Content-Type" => "application/json"}
+    end
+
+    def body
+      {secret: "my-secret"}.to_json
+    end
+
+    def params
+      {my: "params"}
+    end
+
+    def default_action
+      :post # defaults to :get
+    end
+  end
+end
+```
+
+#### Responses
+
+```ruby
+module MyGem
+  class GetUserResponse
+    include APIClientBase::Response.module
+    # - has `#status` method that is delegated to `raw_response.status`
+    # - has `#code` method to get the response's code
+    # - has `#raw_response` which is a Typhoeus response object
+
+    # You're encouraged to use Virtus attributes to extract information cleanly
+    attribute :id, Integer, lazy: true, default: :default_id
+    attribute :name, String, lazy: true, default: :default_name
+    attribute :body, Object, lazy: true, default: :default_body
+
+    private
+
+    # Optional: define `#default_success` to determine what it means for
+    # the response to be successful. For example, the code might be 200
+    # but you consider it a failed call if there are no results
+    def default_success
+      code == 200 && !body[:users].empty?
+    end
+
+    def default_body
+      JSON.parse(raw_response.body).with_indifferent_access
+    end
+
+    def default_id
+      body[:id]
+    end
+
+    def default_name
+      body[:name]
+    end
+  end
+end
+```
+
+You can an example gem at https://github.com/imacchiato/bridge_client-ruby.
+
+## 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/imacchiato/api_client-ruby. 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).

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_client_base.gemspec

@@ -0,0 +1,43 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'api_client_base/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "api_client_base"
+  spec.version       = APIClientBase::VERSION
+  spec.authors       = ["Ramon Tayag"]
+  spec.email         = ["ramon.tayag@gmail.com"]
+
+  spec.summary       = %q{Abstractions to help author API wrappers in Ruby.}
+  spec.description   = %q{Abstractions to help author API wrappers in Ruby.}
+  spec.homepage      = "https://github.com/imacchiato/api_client-ruby"
+  spec.license       = "MIT"
+
+  # Prevent pushing this gem to RubyGems.org. To allow pushes either set the 'allowed_push_host'
+  # to allow pushing to a single host or delete this section to allow pushing to any host.
+  if spec.respond_to?(:metadata)
+    spec.metadata['allowed_push_host'] = "https://rubygems.org"
+  else
+    raise "RubyGems 2.0 or newer is required to protect against " \
+      "public gem pushes."
+  end
+
+  spec.files         = `git ls-files -z`.split("\x0").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_dependency "activesupport", ">= 3.0"
+  spec.add_dependency "virtus", ">= 1.0"
+  spec.add_dependency "typhoeus", ">= 1.0"
+
+  spec.add_development_dependency "bundler", "~> 1.13"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency "virtus-matchers"
+  spec.add_development_dependency "vcr", "~> 3.0"
+  spec.add_development_dependency "webmock"
+end

data/bin/console

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

@@ -0,0 +1,34 @@
+module APIClientBase
+  module Client
+    module ClassMethods
+
+      def api_action(action_name, opts={})
+        define_method action_name do |args|
+          namespace = self.class.name.deconstantize.constantize
+
+          request_class_name = [action_name.to_s.classify, "Request"].join
+          request_class = namespace.const_get(request_class_name)
+
+          response_class_name = [action_name.to_s.classify, "Response"].join
+          response_class = namespace.const_get(response_class_name)
+
+          if opts[:args].is_a?(Array)
+            request_args = opts[:args].each_with_object({}).
+              with_index { |(arg, hash), i| hash[arg] = args[i] }
+          else
+            request_args = args
+          end
+
+          default_request_opts_method =
+            self.class.api_client_base_client_options[:default_opts]
+          default_request_opts = send(default_request_opts_method)
+
+          request = request_class.new(default_request_opts.merge(request_args))
+          raw_response = request.()
+          response_class.new(raw_response: raw_response)
+        end
+      end
+
+    end
+  end
+end

data/lib/api_client_base/client.rb

@@ -0,0 +1,27 @@
+module APIClientBase
+  module Client
+
+    def self.module(opts={})
+      mod = Module.new do
+        mattr_accessor :api_client_base_client_options
+
+        def self.included(base)
+          base.class_attribute :api_client_base_client_options
+          base.api_client_base_client_options = self.api_client_base_client_options
+          base.send :include, APIClientBase::Client
+        end
+      end
+
+      mod.api_client_base_client_options = opts
+
+      mod
+    end
+
+    extend ActiveSupport::Concern
+
+    included do
+      extend APIClientBase::Client::ClassMethods
+    end
+
+  end
+end

data/lib/api_client_base/request.rb

@@ -0,0 +1,71 @@
+module APIClientBase
+  module Request
+
+    def self.module(opts={})
+      mod = Module.new do
+        mattr_accessor :api_client_base_request_options
+
+        def self.included(base)
+          base.class_attribute :api_client_base_request_options
+          base.api_client_base_request_options =
+            self.api_client_base_request_options
+          base.send :include, APIClientBase::Request
+        end
+      end
+
+      mod.api_client_base_request_options = opts
+
+      mod
+    end
+
+    extend ActiveSupport::Concern
+
+    included do
+      include Virtus.model
+      attribute :host, String
+      attribute :uri, String, lazy: true, default: :default_uri
+      attribute :action, Symbol, default: :default_action
+      attribute(:api_client_base_path, String, {
+        lazy: true,
+        default: :default_api_client_base_path,
+      })
+    end
+
+    def call
+      request = Typhoeus::Request.new(
+        uri,
+        method: action,
+        headers: headers,
+        body: body,
+        params: params,
+      )
+
+      request.run
+    end
+
+    private
+
+    def headers ; {}  ; end
+    def body    ; nil ; end
+    def params  ; {}  ; end
+
+    def default_action
+      self.class.api_client_base_request_options[:action] || :get
+    end
+
+    def default_uri
+      uri = URI(host)
+      uri.path = api_client_base_path
+      uri.to_s
+    end
+
+    def default_api_client_base_path
+      path.scan(/:\w+/).reduce(path) do |new_path, var|
+        attribute_name = var.gsub(":", "")
+        value = self.send(attribute_name)
+        new_path.gsub(var, value.to_s)
+      end
+    end
+
+  end
+end

data/lib/api_client_base/response.rb

@@ -0,0 +1,39 @@
+module APIClientBase
+  module Response
+
+    def self.module(opts={})
+      mod = Module.new do
+        mattr_accessor :api_client_base_response_options
+
+        def self.included(base)
+          base.class_attribute :api_client_base_response_options
+          base.api_client_base_response_options =
+            self.api_client_base_response_options
+          base.send :include, APIClientBase::Response
+        end
+      end
+
+      mod.api_client_base_response_options = opts
+
+      mod
+    end
+
+    extend ActiveSupport::Concern
+
+    included do
+      include Virtus.model
+      attribute :raw_response, Object
+      attribute :success, self::Boolean, lazy: true, default: :default_success
+      attribute :code, Integer, lazy: true, default: :default_code
+    end
+
+    def default_success
+      raw_response.success?
+    end
+
+    def default_code
+      raw_response.code
+    end
+
+  end
+end

data/lib/api_client_base/version.rb

@@ -0,0 +1,3 @@
+module APIClientBase
+  VERSION = "0.1.0"
+end

data/lib/api_client_base.rb

@@ -0,0 +1,15 @@
+require "active_support/concern"
+require "active_support/core_ext/class/attribute"
+require "active_support/core_ext/module/attribute_accessors"
+require "active_support/inflector"
+require "typhoeus"
+require "virtus"
+require "api_client_base/version"
+require "api_client_base/client"
+require "api_client_base/client/class_methods"
+require "api_client_base/request"
+require "api_client_base/response"
+
+module APIClientBase
+  # Your code goes here...
+end

metadata

@@ -0,0 +1,189 @@
+--- !ruby/object:Gem::Specification
+name: api_client_base
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Ramon Tayag
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2016-12-15 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: virtus
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: typhoeus
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.13'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.13'
+- !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.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: virtus-matchers
+  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: vcr
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.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'
+description: Abstractions to help author API wrappers in Ruby.
+email:
+- ramon.tayag@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CHANGELOG.md
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- api_client_base.gemspec
+- bin/console
+- bin/setup
+- lib/api_client_base.rb
+- lib/api_client_base/client.rb
+- lib/api_client_base/client/class_methods.rb
+- lib/api_client_base/request.rb
+- lib/api_client_base/response.rb
+- lib/api_client_base/version.rb
+homepage: https://github.com/imacchiato/api_client-ruby
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+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.5.1
+signing_key: 
+specification_version: 4
+summary: Abstractions to help author API wrappers in Ruby.
+test_files: []