api_client_base 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: a47670c0ba3b9854d0b1fe79fff7b6c507770b02
-  data.tar.gz: ddbab067dc66987450d9784f95fceba9c819a71b
+  metadata.gz: 40aec0e5f2dddf675b4e5a7df5e30518d1e28b7f
+  data.tar.gz: 9c225931a08517e543e8818ceef6ce8cc5828e50
 SHA512:
-  metadata.gz: 17c4e3977db0ee463d9606c84b43a68c82ad7b32fed463a05348c1d99a7f54f1ef6e38206611b83b238d2e517272c98fe75375f62d8bf52c0ba9cb5f0ace32b1
-  data.tar.gz: 5ceaf0fcd18fd69a6ff01a0f555ce4f22bf669b35ba55afcd2c2cdcbcaeaa9390739a9f370fc145160cf71327240be29bef83d28525fe8c383056bdbdbd599ab
+  metadata.gz: 7755b15e5885babce88d5116a9f64dacafc8231a92a2c67b0fc22390b3f1128e6ef365f487a26568f502486430428ea52bde05aa5cdace1a58951a36d1f7e121
+  data.tar.gz: ae7ab45a1807d225c906df4235e017c4fcf0ac0b74ab363fe207e6622887418c44ae09466b115e7f5cfbb1b4a3486432fd67668d47e6ed6849fd955bdb4707c4

data/CHANGELOG.md

@@ -4,6 +4,17 @@ 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]
+## [0.2.0]
+### Added
+- Convenience module for gem's base module
+
+### Fixed
+- Do not require arguments to be passed into api actions
+- Do not singularize the action_name. Call camelize instead of classify
+
+### Changed
+- Typhoeus is not a dependency; user must add it if they will use `Request#call`
+
+## [0.1.0] - 2016-12-15
 ### Added
 - Initial release

data/Gemfile

@@ -4,3 +4,4 @@ source 'https://rubygems.org'
 gemspec
 
 gem "pry-byebug"
+gem "typhoeus"

data/README.md

@@ -16,6 +16,34 @@ This gem assumes your gem will follow a certain structure.
   - 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 gem's base module
+
+Do this:
+
+```ruby
+module MyGem
+  include APIClientBase::Base.module
+
+  with_configuration do
+    has :host, classes: String
+    has :username, classes: String
+    has :password, classes: String
+  end
+end
+```
+
+And you can
+
+- configure (thanks to [gem_config](https://github.com/krautcomputing/gem_config)) the gem's base module with defaults:
+
+```ruby
+MyGem.configure do |c|
+  c.host = "https://test.api.com"
+end
+```
+
+- instantiate `MyGem::Client` by calling `MyGem.new(host: "https://api.com", username: "user", password: "password")`. If you do not specify an option, it will use the gem's default.
+
 ### Configuring the `Client`
 
 #### Default Options
@@ -31,12 +59,12 @@ module MyGem
     private
 
     def default_opts
+      # At least include `host`. Other things you may need to include: `token`, `secret`
       { 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
@@ -61,7 +89,6 @@ module MyGem
     private
 
     def all_opts
-      # At least include `host`. Other things you may need to include: `token`, `secret`
       { host: "http://prod.com" }
     end
   end
@@ -75,9 +102,12 @@ You still need to create `MyGem::GetUserRequest` and `MyGem::GetUserResponse`. S
 
 #### Requests
 
+Requests assume a REST-like structure. This currently does not play well with a SOAP server. You could still use the `Base`, `Client`, and `Response` modules however. For SOAP APIs, write your own Request class that defines `#call`. This method needs to return the `raw_response`.
+
 ```ruby
 module MyGem
   class GetUserRequest
+    # You must install typhoeus if you use the `APIClientBase::Request`. Add it to your gemfile.
     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)
@@ -86,7 +116,13 @@ module MyGem
     private
 
     def path
-      "/api/v1/users/#{self.user_id}"
+      # all occurrences of `/:\w+/` in the string will have the matches replaced with the
+      # request object's value of that method. For example, if `request.user_id` is 33
+      # then you will get "/api/v1/users/33" as the path
+      "/api/v1/users/:user_id"
+
+      # Or you can interpolate it yourself if you want
+      # "/api/v1/users/#{self.user_id}"
     end
 
     # Following methods are optional. Override them if you need to send something specific

data/api_client_base.gemspec

@@ -32,7 +32,7 @@ Gem::Specification.new do |spec|
 
   spec.add_dependency "activesupport", ">= 3.0"
   spec.add_dependency "virtus", ">= 1.0"
-  spec.add_dependency "typhoeus", ">= 1.0"
+  spec.add_dependency "gem_config", ">= 0.3.1"
 
   spec.add_development_dependency "bundler", "~> 1.13"
   spec.add_development_dependency "rake", "~> 10.0"

data/lib/api_client_base/base/class_methods.rb

@@ -0,0 +1,13 @@
+module APIClientBase
+  module Base
+    module ClassMethods
+
+      def new(opts={})
+        client_class = self.const_get("Client")
+        client_opts = self.configuration.current.merge(opts)
+        client_class.new(client_opts)
+      end
+
+    end
+  end
+end

data/lib/api_client_base/base.rb

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

data/lib/api_client_base/client/class_methods.rb

@@ -3,13 +3,13 @@ module APIClientBase
     module ClassMethods
 
       def api_action(action_name, opts={})
-        define_method action_name do |args|
+        define_method action_name do |args={}|
           namespace = self.class.name.deconstantize.constantize
 
-          request_class_name = [action_name.to_s.classify, "Request"].join
+          request_class_name = [action_name.to_s.camelize, "Request"].join
           request_class = namespace.const_get(request_class_name)
 
-          response_class_name = [action_name.to_s.classify, "Response"].join
+          response_class_name = [action_name.to_s.camelize, "Response"].join
           response_class = namespace.const_get(response_class_name)
 
           if opts[:args].is_a?(Array)

data/lib/api_client_base/request.rb

@@ -32,15 +32,20 @@ module APIClientBase
     end
 
     def call
-      request = Typhoeus::Request.new(
-        uri,
-        method: action,
-        headers: headers,
-        body: body,
-        params: params,
-      )
+      require "typhoeus"
+      if defined?(Typhoeus)
+        request = Typhoeus::Request.new(
+          uri,
+          method: action,
+          headers: headers,
+          body: body,
+          params: params,
+        )
 
-      request.run
+        request.run
+      else
+        fail "Either override #call or make sure Typhoeus is available for use."
+      end
     end
 
     private

data/lib/api_client_base/version.rb

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

data/lib/api_client_base.rb

@@ -2,9 +2,11 @@ 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 "gem_config"
 require "virtus"
 require "api_client_base/version"
+require "api_client_base/base"
+require "api_client_base/base/class_methods"
 require "api_client_base/client"
 require "api_client_base/client/class_methods"
 require "api_client_base/request"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: api_client_base
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Ramon Tayag
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-12-15 00:00:00.000000000 Z
+date: 2016-12-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -39,19 +39,19 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '1.0'
 - !ruby/object:Gem::Dependency
-  name: typhoeus
+  name: gem_config
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '1.0'
+        version: 0.3.1
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '1.0'
+        version: 0.3.1
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -156,6 +156,8 @@ files:
 - bin/console
 - bin/setup
 - lib/api_client_base.rb
+- lib/api_client_base/base.rb
+- lib/api_client_base/base/class_methods.rb
 - lib/api_client_base/client.rb
 - lib/api_client_base/client/class_methods.rb
 - lib/api_client_base/request.rb