abstract_api_wrapper 1.2.0 → 1.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 382d69983b02149041ca9c27e0fed424c84a147b
-  data.tar.gz: dca2dc1bf4ade4eaf0f1946839b0c9fcc6b710e1
+  metadata.gz: d44dac1f1b099e9dade84a4fd871547a1778c855
+  data.tar.gz: ccf0fbf273198e999b19796f65e23f16f4899fc9
 SHA512:
-  metadata.gz: c83865eb6828abc65adde8eb510b776204e380a81689d468596be7d6c501cec176a92e8b8586bd5d8945a398ad863321a52b8d72783e97a5a8cdcfe1e6966528
-  data.tar.gz: 5693c006e199cde8b6ef97270673752f59d174aaade72219c0714bd4f6bf4a9f531d5f39bc39c8fd7a74169ed618f76ad8e221990b4afc1b6f5689ca41660cd8
+  metadata.gz: 9594e279953f13a993239b5bf7b0ec10df2bcf4d75a8fdb91e024752b70c89282313d6444809b540d612f2bcea1d2f04e9b2d8e6ccfb5386bae21ab41f477bf5
+  data.tar.gz: f41d40d4cb674ebc1160c8b542d1557c7bacc18003ec91b7b607644bd03d7e94df32596f39de1b98dd9811596b09917d173018fdd271bf62d7ec1a56780eb956

data/README.md

@@ -1,6 +1,6 @@
 # AbstractApiWrapper
 
-TODO: summary
+An abstract REST API wrapper based on `missing_method` magic.
 
 ## Installation
 
@@ -20,24 +20,50 @@ Or install it yourself as:
 
 ## Usage
 
-Modify the `endpoint` method appending the `.json` extension to all requests
+Define a new class and extend it with `AbstractApiWrapper`, then Modify the `Request#endpoint` and/or `Request#headers` methods to fit your requirements.
 
 ```ruby
-def endpoint
-  query_string = filters.map { |k, v| "#{k}=#{v}" }.join('&')
-  "#{@client.base_url}/#{path.join('/')}.json?#{query_string}"
+# Basecamp example
+class BasecampApi < AbstractApiWrapper
+  class Client < BasecampApi::Client
+    def method_missing(name, *params, &block)
+      BasecampApi::Request.new(name.to_s, self)
+    end
+  end
+
+  class Request < BasecampApi::Request
+    def headers
+      # Use Bearer instead of token
+      {
+        'Authorization' => "Bearer #{@client.access_token}",
+        'Content-Type' => 'application/json'
+      }
+    end
+
+    def endpoint
+      # Adds the .json at the end of each request
+      query_string = filters.map { |k, v| "#{k}=#{v}" }.join('&')
+      "#{@client.base_url}/#{path.join('/')}.json?#{query_string}"
+    end
+  end
 end
 ```
 
 ```ruby
 ACCESS_TOKEN = "YOUR ACCESS TOKEN"
-client = AbstractApiWrapper::Client.new(access_token: ACCESS_TOKEN, base_url: 'https://launchpad.37signals.com')
+
+client = BasecampApi::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">>
+# => <BasecampApi::Response::Resource accounts=#<Hashie::Array [#<BasecampApi::Response::Resource app_href="https://basecamp.com/xxxxxxx" href="https://basecamp.com/xxxxxxx/api/v1" id=xxxxxxx name="Your Company" product="bcx">, #<BasecampApi::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=#<BasecampApi::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)
+client = BasecampApi::Client.new(access_token: ACCESS_TOKEN, base_url: account.href)
 projects = client.projects.all.run
+
 puts projects
 puts projects.pagination
 ```

data/lib/abstract_api_wrapper.rb

@@ -14,7 +14,7 @@ class AbstractApiWrapper
     end
 
     def method_missing(name, *params, &block)
-      AbstractApiWrapper::Request.new(name.to_s, self)
+      Request.new(name.to_s, self)
     end
   end
 
@@ -80,7 +80,7 @@ class AbstractApiWrapper
       params = @params.any? ? @params.to_json : nil
 
       request = Faraday.send(method, endpoint, params, headers)
-      response = AbstractApiWrapper::Response.new(request)
+      response = Response.new(request)
 
       # Reset variables
       path    = []
@@ -122,13 +122,13 @@ class AbstractApiWrapper
 
     def body
       if @parsed_body.is_a?(Hash)
-        AbstractApiWrapper::Response::Resource.new(@parsed_body, @request)
+        Response::Resource.new(@parsed_body, @request)
       elsif @parsed_body.is_a?(Array)
         collection = @parsed_body.map do |item|
-          AbstractApiWrapper::Response::Resource.new(item)
+          Response::Resource.new(item)
         end
 
-        AbstractApiWrapper::Response::Collection.new(collection, @request)
+        Response::Collection.new(collection, @request)
       end
     end
 

data/lib/abstract_api_wrapper/version.rb

@@ -1,3 +1,3 @@
 class AbstractApiWrapper
-  VERSION = '1.2.0'
+  VERSION = '1.3.0'
 end

data/spec/abstract_api_wrapper_spec.rb

@@ -1,9 +1,4 @@
-$LOAD_PATH.unshift File.expand_path('../../lib', __FILE__)
-require 'webmock/rspec'
-require 'abstract_api_wrapper'
-
-include WebMock::API
-WebMock.enable!
+require 'helper'
 
 TEST_OPTIONS = {
   base_url: 'https://mysuperapi.com/api',
@@ -66,7 +61,7 @@ describe 'AbstractApiWrapper' do
       @client = AbstractApiWrapper::Client.new(TEST_OPTIONS)
 
       stub_request(:get, TEST_OPTIONS[:base_url])
-        .to_return(:status => 200, :body => '[]')
+        .to_return(status: 200, body: '[]')
 
       @request = Faraday.get(TEST_OPTIONS[:base_url])
     end

data/spec/helper.rb

@@ -0,0 +1,6 @@
+$LOAD_PATH.unshift File.expand_path('../../lib', __FILE__)
+require 'webmock/rspec'
+require 'abstract_api_wrapper'
+
+include WebMock::API
+WebMock.enable!

data/spec/inheritance_spec.rb

@@ -0,0 +1,50 @@
+require 'helper'
+
+class BasecampApi < AbstractApiWrapper
+  class Client < BasecampApi::Client
+    def method_missing(name, *params, &block)
+      BasecampApi::Request.new(name.to_s, self)
+    end
+  end
+
+  class Request < BasecampApi::Request
+    def headers
+      {
+        'Authorization' => "Bearer #{@client.access_token}",
+        'Content-Type' => 'application/json'
+      }
+    end
+
+    def endpoint
+      query_string = filters.map { |k, v| "#{k}=#{v}" }.join('&')
+      "#{@client.base_url}/#{path.join('/')}.json?#{query_string}"
+    end
+  end
+end
+
+describe 'BasecampApi' do  
+  describe 'Request' do
+    subject {
+      client = BasecampApi::Client.new(
+        apiver: '1',
+        base_url: 'http://localhost.com',
+        access_token: '123'
+      )
+    }
+
+    it 'should contain a .json in the request endpoint' do
+      request = subject.projects.all
+      expect(request).to be_kind_of(BasecampApi::Request)
+      expect(request.endpoint).to include('projects.json')
+    end
+
+    it 'should use Bearer as token in Authorization header' do
+      stub_request(:get, 'http://localhost.com/users.json')
+        .with(headers: { 'Authorization' => 'Bearer 123' })
+        .to_return(status: 200, body: "")
+
+      response = subject.users.all.run
+      expect(response.request.status).to be(200)
+    end
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: abstract_api_wrapper
 version: !ruby/object:Gem::Version
-  version: 1.2.0
+  version: 1.3.0
 platform: ruby
 authors:
 - Juan Puelpan
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-12-07 00:00:00.000000000 Z
+date: 2016-12-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: json
@@ -126,6 +126,8 @@ files:
 - lib/abstract_api_wrapper.rb
 - lib/abstract_api_wrapper/version.rb
 - spec/abstract_api_wrapper_spec.rb
+- spec/helper.rb
+- spec/inheritance_spec.rb
 homepage: https://github.com/octopull/abstract_api_wrapper
 licenses: []
 metadata: {}