abstract_api_wrapper 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 41eb4526da6c48255ee04ef0cf6ee56fb0e0af85
+  data.tar.gz: d3f6a78965318217ad58c685e0c6e02b5ee975d4
+SHA512:
+  metadata.gz: 0ac6d2491828a02e03ddff2668fddd8f98ac97344c87602c9aa4d66d5f2d5d71f98f7bbba15e66052e38f63d584fa90ba42c38432bf41f5a79bb193deba36640
+  data.tar.gz: add2a654238708294e2bd500681a585b67849d2fd52bc0e0c67d5ffee6892a56e90a35545dafafcd406f1c1d90c0812afb5d4a5cb2abd402989fdd03ea6de26f

data/.gitignore

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

data/.rspec

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

data/Gemfile

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

data/README.md

@@ -0,0 +1,48 @@
+# AbstractApiWrapper
+
+TODO: summary
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'abstract_api_wrapper'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install abstract_api_wrapper
+
+## Usage
+
+Modify the `endpoint` method appending the `.json` extension to all requests
+
+```ruby
+def endpoint
+  query_string = filters.map { |k, v| "#{k}=#{v}" }.join('&')
+  "#{@client.base_url}/#{path.join('/')}.json?#{query_string}"
+end
+```
+
+```ruby
+ACCESS_TOKEN = "YOUR ACCESS TOKEN"
+client = AbstractApiWrapper::Client.new(access_token: ACCESS_TOKEN, base_url: 'https://launchpad.37signals.com')
+authorizations = client.authorization.all.run
+# => <AbstractApiWrapper::Response::Resource accounts=#<Hashie::Array [#<AbstractApiWrapper::Response::Resource app_href="https://basecamp.com/xxxxxxx" href="https://basecamp.com/xxxxxxx/api/v1" id=xxxxxxx name="Your Company" product="bcx">, #<AbstractApiWrapper::Response::Resource app_href="https://basecamp.com/xxxxxxx" href="https://basecamp.com/xxxxxxx/api/v1" id=xxxxxxx name="Another company" product="bcx">]> expires_at="2016-12-19T18:13:52.000Z" identity=#<AbstractApiWrapper::Response::Resource email_address="email@yourcompany.com" first_name="Juan" id=xxxxxx last_name="Puelpan">>
+
+account = authorizations.accounts.first
+client = AbstractApiWrapper::Client.new(access_token: ACCESS_TOKEN, base_url: account.href)
+projects = client.projects.all.run
+puts projects
+puts projects.pagination
+```
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/octopull/abstract_api_wrapper.
+

data/Rakefile

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

data/abstract_api_wrapper.gemspec

@@ -0,0 +1,29 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'abstract_api_wrapper/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'abstract_api_wrapper'
+  spec.version       = AbstractApiWrapper::VERSION
+  spec.authors       = ['Juan Puelpan']
+  spec.email         = ['juan@octopull.us']
+
+  spec.summary       = %q{An abstract REST API wrapper}
+  spec.description   = %q{An abstract REST API wrapper based on missing_method magic}
+  spec.homepage      = "https://github.com/octopull/abstract_api_wrapper"
+
+  spec.files         = `git ls-files`.split("\n")
+  spec.bindir        = 'exe'
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  spec.add_dependency 'json'    , '~> 2.0'
+  spec.add_dependency 'faraday' , '~> 0.10'
+  spec.add_dependency 'hashie'  , '~> 3.4'
+
+  spec.add_development_dependency 'bundler' , '~> 1.11'
+  spec.add_development_dependency 'rake'    , '~> 10.0'
+  spec.add_development_dependency 'rspec'   , '~> 3.5'
+  spec.add_development_dependency 'webmock' , '~> 1.24'
+end

data/bin/console

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

@@ -0,0 +1,169 @@
+require 'abstract_api_wrapper/version'
+require 'json'
+require 'faraday'
+require 'hashie/mash'
+
+class AbstractApiWrapper
+  class Client
+    attr_reader :access_token, :base_url, :apiver
+
+    def initialize(**options)
+      @base_url      = options[:base_url]
+      @apiver        = options[:apiver]
+      @access_token  = options[:access_token]
+    end
+
+    def method_missing(name, *params, &block)
+      AbstractApiWrapper::Request.new(name.to_s, self)
+    end
+  end
+
+  class Request
+    attr_accessor :path, :filters, :chain
+
+    METHODS_MAP = {
+      'all'     => 'get',
+      'head'    => 'head',
+      'find'    => 'get',
+      'create'  => 'post',
+      'update'  => 'put',
+      'destroy' => 'delete'
+    }.freeze
+
+    def initialize(*options)
+      @client  = options[1]
+      @path    = []
+      @chain   = []
+      @filters = Hashie::Mash.new
+      @params  = Hashie::Mash.new
+
+      method_name = options[0]
+
+      unless method_name.nil?
+        @path  << method_name
+        @chain << method_name
+      end
+    end
+
+    def method_missing(name, *params, &block)
+      method_name = name.to_s
+      return self if chain.last == method_name
+
+      chain.push(method_name)
+
+      case method_name
+      when 'all'
+        filters.merge!(params.first || {})
+      when 'head'
+        filters.merge!(params.first || {})
+      when 'find'
+        path.push(params.first.to_s)
+      when 'create'
+        @params = Hashie::Mash.new(params.first || {})
+      when 'update'
+        if chain[-2] == 'find'
+          @params = Hashie::Mash.new(params.first || {})
+        end
+      when 'destroy'
+        if chain[-2] == 'find'
+          path.push(params.first.to_s)
+        end
+      else
+        path.push(method_name)
+      end
+
+      self
+    end
+
+    def run
+      method = METHODS_MAP[@chain.last] || 'get'
+      params = @params.any? ? @params.to_json : nil
+
+      request = Faraday.send(method, endpoint, params, headers)
+      response = AbstractApiWrapper::Response.new(request)
+
+      # Reset variables
+      path    = []
+      chain   = []
+      filters = Hashie::Mash.new
+      params  = Hashie::Mash.new
+
+      response.body
+    end
+
+    def headers
+      {
+        'Authorization' => "token #{@client.access_token}",
+        'Content-Type' => 'application/json'
+      }
+    end
+
+    def endpoint
+      # Here is a Query String API versioning with the `apiver` param
+      # You can change this to whatever your API versioning system is
+      filters.apiver = @client.apiver
+      query_string   = filters.map { |k, v| "#{k}=#{v}" }.join('&')
+
+      "#{@client.base_url}/#{path.join('/')}?#{query_string}"
+    end
+  end
+
+  class Response
+
+    def initialize(request)
+      @request = request
+
+      @parsed_body = if (request.body.nil? || request.body.empty?)
+        []
+      else
+        JSON.parse(request.body)
+      end
+    end
+
+    def body
+      if @parsed_body.is_a?(Hash)
+        AbstractApiWrapper::Response::Resource.new(@parsed_body, @request)
+      elsif @parsed_body.is_a?(Array)
+        collection = @parsed_body.map do |item|
+          AbstractApiWrapper::Response::Resource.new(item)
+        end
+
+        AbstractApiWrapper::Response::Collection.new(collection, @request)
+      end
+    end
+
+    class Resource < Hashie::Mash
+      attr_reader :request
+
+      def initialize(*options)
+        @request = options[1] if options[1]
+        super(options[0])
+      end
+    end
+
+    class Collection < Array
+      attr_reader :request
+
+      def initialize(*options)
+        @request = options[1] if options[1]
+        super(options[0])
+      end
+
+      def headers
+        @headers ||= @request.headers
+      end
+
+      def pagination
+        @pagination ||= Hashie::Mash.new(
+          next_page: headers['x-next-page'].to_i,
+          offset: headers['x-offset'].to_i,
+          page: headers['x-page'].to_i,
+          per_page: headers['x-per-page'].to_i,
+          prev_page: headers['prev_page'].to_i,
+          total: headers['x-total'].to_i,
+          total_pages: headers['x-total-pages'].to_i
+        )
+      end
+    end
+  end
+end

data/lib/abstract_api_wrapper/version.rb

@@ -0,0 +1,3 @@
+class AbstractApiWrapper
+  VERSION = '1.0.0'
+end

data/spec/abstract_api_wrapper_spec.rb

@@ -0,0 +1,113 @@
+$LOAD_PATH.unshift File.expand_path('../../lib', __FILE__)
+require 'webmock/rspec'
+require 'abstract_api_wrapper'
+
+include WebMock::API
+WebMock.enable!
+
+TEST_OPTIONS = {
+  base_url: 'https://mysuperapi.com/api',
+  apiver: 'v3',
+  access_token: 'mysupersecrettoken'
+}
+
+describe 'AbstractApiWrapper' do
+  describe 'Client' do
+    it 'should create a Client with the given options' do
+      client = AbstractApiWrapper::Client.new(TEST_OPTIONS)
+      expect(client.access_token).to eq('mysupersecrettoken')
+      expect(client.base_url).to eq('https://mysuperapi.com/api')
+      expect(client.apiver).to eq('v3')
+    end
+  end
+
+  describe 'Request' do
+    before(:each) do
+      @client = AbstractApiWrapper::Client.new(TEST_OPTIONS)
+    end
+
+    it 'should return a Request instance' do
+      request = @client.users.all
+      expect(request.client).to be_kind_of(AbstractApiWrapper::Request)
+    end
+
+    it 'should return the same Request instance' do
+      user = @client.users.find(1)
+      project = user.projects.find(1)
+
+      expect(user).to be_kind_of(AbstractApiWrapper::Request)
+      expect(project).to be_kind_of(AbstractApiWrapper::Request)
+
+      expect(user.object_id).to eq(project.object_id)
+    end
+
+    it 'should create a path as array' do
+      request = @client.users.find(1)
+      expect(request.path).to be_kind_of(Array)
+      expect(request.path.last).to eq('1')
+      expect(request.path).to eq(['users', '1'])
+    end
+
+    it 'should set the filters' do
+      request = @client.users.all(active: true)
+      expect(request.filters).to be_kind_of(Hashie::Mash)
+      expect(request.filters).to eq({ 'active' => true })
+    end
+
+    it 'should set the path chain' do
+      request = @client.users.find(1).projects.all(active: true)
+      expect(request.chain).to be_kind_of(Array)
+      expect(request.chain).to eq(['users', 'find', 'projects', 'all'])
+    end
+  end
+
+  describe 'Response' do
+    before(:each) do
+      @client = AbstractApiWrapper::Client.new(TEST_OPTIONS)
+
+      stub_request(:get, TEST_OPTIONS[:base_url])
+        .to_return(:status => 200, :body => '[]')
+
+      @request = Faraday.get(TEST_OPTIONS[:base_url])
+    end
+
+    it 'should return a Response instance' do
+      response = AbstractApiWrapper::Response.new(@request)
+      expect(response).to be_kind_of(AbstractApiWrapper::Response)
+    end
+
+    it 'should parse the response body as JSON' do
+      response = AbstractApiWrapper::Response.new(@request)
+      expect(response.body).to be_kind_of(AbstractApiWrapper::Response::Collection)
+    end
+
+    describe 'Resource' do
+      before(:each) do
+        @item = { id: 1, full_name: 'Jon Snow', email: 'jon@winterfell.com' }
+      end
+
+      it 'should create a new Resource from a Hash' do
+        resource = AbstractApiWrapper::Response::Resource.new(@item)
+
+        expect(resource).to be_kind_of(Hashie::Mash)
+        expect(resource.id).to eq(1)
+        expect(resource.full_name).to eq('Jon Snow')
+        expect(resource.email).to eq('jon@winterfell.com')
+        expect(resource.request).to be_nil
+      end
+
+      it 'should assign the Request object from params' do
+        request = Faraday.get(TEST_OPTIONS[:base_url])
+        resource = AbstractApiWrapper::Response::Resource.new(@item, request)
+
+        expect(resource).to be_kind_of(Hashie::Mash)
+        expect(resource.request).to be_kind_of(Faraday::Response)
+      end
+    end
+
+    # TODO: Collection tests
+    # describe 'Collection' do
+    # end
+  end
+
+end

metadata

@@ -0,0 +1,153 @@
+--- !ruby/object:Gem::Specification
+name: abstract_api_wrapper
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Juan Puelpan
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2016-12-07 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: json
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: faraday
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.10'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.10'
+- !ruby/object:Gem::Dependency
+  name: hashie
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.4'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.4'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+- !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.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.5'
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.24'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.24'
+description: An abstract REST API wrapper based on missing_method magic
+email:
+- juan@octopull.us
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- Gemfile
+- README.md
+- Rakefile
+- abstract_api_wrapper.gemspec
+- bin/console
+- bin/setup
+- lib/abstract_api_wrapper.rb
+- lib/abstract_api_wrapper/version.rb
+- spec/abstract_api_wrapper_spec.rb
+homepage: https://github.com/octopull/abstract_api_wrapper
+licenses: []
+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.5.1
+signing_key: 
+specification_version: 4
+summary: An abstract REST API wrapper
+test_files: []
+has_rdoc: