clientele 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 7094f398e0787615dcaad936f4886c7ef0d06e76
+  data.tar.gz: 3ba778bd32cf86045ff472fa3658660833920261
+SHA512:
+  metadata.gz: dd64329a884aecaa05ba59ea9307bca73c556464c828926a9a888a7c3e4da3cb2bc64c7f6e386877e92c815d8b1d042a74fcacd38f130abb074af232a0a4c18d
+  data.tar.gz: ff01128ff6dca97923c7166ecd8c567b45f36d8a3eb88345a08eb149d8a9bf1fd6c46d5c6b8e469b83410720bec31178fe4861081a642762f0f416c70c52aacd

data/.gitignore

@@ -0,0 +1,22 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log

data/Gemfile

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

data/LICENSE.md

@@ -0,0 +1,25 @@
+> **Copyright (c) 2014 Chris Keele**
+
+MIT License
+-----------
+
+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,30 @@
+Clientele
+=========
+
+> *DSL for creating RESTful API clients for external services.*
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'clientele'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install clientele
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Contributing
+
+1. Fork it ( https://github.com/[my-github-username]/clientele/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request

data/Rakefile

@@ -0,0 +1,2 @@
+require "bundler/gem_tasks"
+

data/clientele.gemspec

@@ -0,0 +1,37 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'clientele/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "clientele"
+  spec.version       = Clientele::VERSION
+  spec.authors       = ["Chris Keele"]
+  spec.email         = ["dev@chriskeele.com"]
+  spec.summary       = 'DSL for creating RESTful API clients for external services.'
+  spec.description   = <<-DESC
+    DSL for creating RESTful API clients for external services.
+
+
+  DESC
+  spec.homepage      = "https://github.com/christhekeele/clientele"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.required_ruby_version = '~> 2.0'
+
+  spec.add_dependency "faraday", "~> 0.9.0"
+  spec.add_dependency "faraday_middleware", "~> 0.9.0"
+  spec.add_dependency "rash", "~> 0.4.0"
+  spec.add_dependency "block_party", ">= 0.1.2"
+  spec.add_dependency "activesupport", "> 3.2"
+
+  spec.add_development_dependency "bundler", "> 1.3"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rspec",   "~> 2.14"
+  spec.add_development_dependency "pry"
+end

data/lib/clientele/api.rb

@@ -0,0 +1,85 @@
+require 'forwardable'
+
+require 'block_party'
+require 'active_support/core_ext/class/attribute'
+
+require 'clientele/configuration'
+require 'clientele/request_builder'
+require 'clientele/request'
+require 'clientele/resource'
+
+module Clientele
+  class API
+
+    extend BlockParty::Configurable
+    configure_with Configuration
+
+    extend SingleForwardable
+    def_delegator :configuration, :logger
+    def_delegators :request, *Request::VERBS
+
+    class_attribute :resources, instance_predicate: false
+    self.resources = {}
+
+    class << self
+
+      def client(opts={})
+        autoconfigure!
+        @client ||= new(opts)
+      end
+
+      def logger
+        autoconfigure!
+        configuration.logger
+      end
+
+      def resource(klass)
+        self.resources = resources.merge(:"#{klass}" => klass)
+      end
+
+    private
+
+      def autoconfigure!
+        self.configure unless configuration
+      end
+
+      def respond_to_missing?(method_name, include_private=false)
+        client.respond_to? method_name, include_private
+      end
+
+      def method_missing(method_name, *args, &block)
+        autoconfigure!
+        if respond_to_missing?(method_name, false)
+          client.send method_name, *args, &block
+        else; super; end
+      end
+
+    end
+
+    def initialize(opts={})
+      self.extend BlockParty::Configurable
+      self.configure_with self.class.configuration.class
+      self.configuration = self.class.configuration.clone
+      self.configuration.load_hash opts
+    end
+
+  protected
+
+    def request
+      Request
+    end
+
+  private
+
+    def respond_to_missing?(method_name, include_private=false)
+      resources.keys.include?(method_name) or super
+    end
+
+    def method_missing(method_name, *args, &block)
+      if resources.keys.include? method_name
+        RequestBuilder.new(self.class::resources[method_name], client: self)
+      else; super; end
+    end
+
+  end
+end

data/lib/clientele/configuration.rb

@@ -0,0 +1,17 @@
+require 'logger'
+
+require 'faraday'
+
+module Clientele
+  class Configuration < BlockParty::Configuration
+
+    attr_accessor :logger, :adapter, :headers, :root_url
+
+    def initialize
+      self.logger   =  Logger.new($stdout)
+      self.adapter  =  Faraday.default_adapter
+      self.headers  =  {}
+    end
+
+  end
+end

data/lib/clientele/exceptions.rb

@@ -0,0 +1,3 @@
+module Clientele
+  class ConfigurationError < RuntimeError; end
+end

data/lib/clientele/request.rb

@@ -0,0 +1,97 @@
+require 'json'
+
+require 'faraday'
+require 'faraday_middleware'
+require 'rash'
+
+require 'clientele/utils'
+
+module Clientele
+  class Request < Struct.new(:verb, :path, :query, :body, :headers, :options, :callback, :resource)
+    include Clientele::Utils
+
+    VERBS = %i[get post put patch delete]
+    VERBS.each do |verb|
+      define_singleton_method verb do |opts={}, &callback|
+        new opts.merge(verb: __method__, callback: callback)
+      end
+    end
+
+    def initialize(props={})
+      apply self.class.defaults
+      apply props
+    end
+
+    def async?
+      !!callback
+    end
+
+    def url
+      ensure_trailing_slash merge_paths options[:root_url], path
+    end
+
+    def to_request(options={})
+      tap do |request|
+        request.options.deep_merge! options
+      end
+    end
+
+    def call
+      callback ? callback.call(response) : response
+    end
+    alias_method :~, :call
+
+    def + other
+      self.class.new(
+        verb:     other.verb || verb,
+        path:     merge_paths(path, other.path),
+        query:    query.merge(other.query),
+        body:     body.merge(other.body),
+        headers:  headers.merge(other.headers),
+        options:  options.merge(other.options),
+        callback: other.callback || callback,
+        resource: other.resource || resource,
+      )
+    end
+
+  private
+
+    def response
+      faraday_client.send(verb, ensure_trailing_slash(path)) do |request|
+        request.headers = options.fetch(:headers, {}).merge(headers)
+        request.params  = deep_camelize_keys(query)
+        request.body    = JSON.dump(deep_camelize_keys(body))
+      end
+    end
+
+    def faraday_client
+      Faraday.new(options[:root_url]) do |conn|
+        conn.response :rashify
+        conn.response :json, content_type: /\bjson$/, preserve_raw: true
+        conn.adapter options[:adapter]
+      end
+    end
+
+    class << self
+      def defaults
+        {
+          verb:     :get,
+          path:     nil,
+          query:    {},
+          body:     {},
+          headers:  {},
+          options:  {},
+          callback: nil,
+          resource: nil,
+        }
+      end
+    end
+
+    def apply(hash={})
+      hash.each do |key, value|
+        self.send :"#{key}=", value
+      end
+    end
+
+  end
+end

data/lib/clientele/request_builder.rb

@@ -0,0 +1,75 @@
+require 'clientele/api'
+require 'clientele/utils'
+
+module Clientele
+  class RequestBuilder
+    include Clientele::Utils
+
+    def initialize(*resources, client: API.client)
+      @stack = Array(resources)
+      @client = client
+    end
+
+    def call
+      build.call
+    end
+    alias_method :~, :call
+
+  protected
+
+    def build
+      @stack.map(&:to_request).inject(:+).to_request(@client.configuration.to_hash)
+    end
+
+    def to_a
+      @stack
+    end
+
+    # Compare values only, class doesn't matter
+    def == other
+      to_a.zip(other.to_a).all? do |mine, theirs|
+        mine == theirs
+      end
+    end
+
+    # Compare values only, class matters
+    def eql?(other)
+      if other.is_a?(RequestBuilder)
+        to_a.zip(other.to_a).all? do |mine, theirs|
+          mine.eql? theirs
+        end
+      end
+    end
+
+    # Compare classes or instances for case statements
+    def === other
+      unless other.is_a? Class
+        to_a == other.to_a if other.respond_to? :to_a
+      else
+        super
+      end
+    end
+
+    def to_s
+      merge_paths(@stack.map(&:to_s))
+    end
+
+  private
+
+    def method_missing(method_name, *args, &block)
+      if API::resources.keys.include? method_name
+        @stack << API::resources[method_name]
+        self
+      elsif @stack.last.respond_to? method_name, false
+        @stack = @stack[0..-2] << @stack.last.send(method_name, *args, &block)
+        self
+      else; super; end
+    end
+    def respond_to_missing?(method_name, include_private=false)
+      API::resources.keys.include?(method_name) \
+      or @stack.last.respond_to?(method_name, include_private) \
+      or super
+    end
+
+  end
+end

data/lib/clientele/resource.rb

@@ -0,0 +1,44 @@
+require 'clientele/request'
+require 'clientele/utils'
+
+require 'active_support/core_ext/string/inflections'
+
+module Clientele
+  class Resource
+    include Clientele::Utils
+
+    @subclasses = []
+
+    class << self
+      include Clientele::Utils
+      attr_reader :subclasses
+      attr_accessor :path
+
+      def request(verb, path='', query: {}, body: {}, options: {}, &callback)
+        Request.send(verb,
+          path: merge_paths(@path || to_s, path),
+          query: query,
+          body: body,
+          options: options,
+          resource: self,
+          &callback
+        )
+      end
+
+      def to_request(options={}, &callback)
+        request :get, options: options, callback: callback
+      end
+
+      def to_s
+        self.name.split('::').last.pluralize.underscore
+      end
+
+    private
+
+      def inherited(base)
+        @subclasses << base
+      end
+    end
+
+  end
+end

data/lib/clientele/utils.rb

@@ -0,0 +1,25 @@
+require 'active_support/core_ext/hash'
+require 'active_support/core_ext/object/blank'
+require 'active_support/core_ext/string/inflections'
+
+module Clientele
+  module Utils
+
+  module_function
+
+    def merge_paths(*urls)
+      ensure_trailing_slash urls.reject(&:blank?).join('/').sub(/(?<!:)\/+/, '/')
+    end
+
+    def ensure_trailing_slash(url)
+      url.end_with?('/') ? url : url + '/'
+    end
+
+    def deep_camelize_keys(hash)
+      hash.deep_transform_keys do |key|
+        key.to_s.camelize(:lower)
+      end
+    end
+
+  end
+end

data/lib/clientele/version.rb

@@ -0,0 +1,3 @@
+module Clientele
+  VERSION = "0.0.1"
+end

data/lib/clientele.rb

@@ -0,0 +1,6 @@
+require "clientele/api"
+require "clientele/version"
+
+# module Clientele
+#
+# end

metadata

@@ -0,0 +1,188 @@
+--- !ruby/object:Gem::Specification
+name: clientele
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Chris Keele
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-07-15 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: faraday
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.9.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.9.0
+- !ruby/object:Gem::Dependency
+  name: faraday_middleware
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.9.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.9.0
+- !ruby/object:Gem::Dependency
+  name: rash
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.4.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.4.0
+- !ruby/object:Gem::Dependency
+  name: block_party
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.1.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.1.2
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">"
+      - !ruby/object:Gem::Version
+        version: '3.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">"
+      - !ruby/object:Gem::Version
+        version: '3.2'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rake
+  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: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.14'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.14'
+- !ruby/object:Gem::Dependency
+  name: pry
+  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: |2+
+      DSL for creating RESTful API clients for external services.
+
+
+email:
+- dev@chriskeele.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE.md
+- README.md
+- Rakefile
+- clientele.gemspec
+- lib/clientele.rb
+- lib/clientele/api.rb
+- lib/clientele/configuration.rb
+- lib/clientele/exceptions.rb
+- lib/clientele/request.rb
+- lib/clientele/request_builder.rb
+- lib/clientele/resource.rb
+- lib/clientele/utils.rb
+- lib/clientele/version.rb
+homepage: https://github.com/christhekeele/clientele
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - "~>"
+    - !ruby/object:Gem::Version
+      version: '2.0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.2.2
+signing_key: 
+specification_version: 4
+summary: DSL for creating RESTful API clients for external services.
+test_files: []