basic_client 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: a54f7d7aa446060fc229685947bf8a91a828f131
+  data.tar.gz: 952589a865d90d6f7fdbf4992a85ad05b4190cd0
+SHA512:
+  metadata.gz: bf64642aaff39bfa8b01065f8ea01b18fedb77f94f09d011352a15c144647c3265194f3e7c907c3ffc57f236a03d43c516550635757aed2ead31d3d569196540
+  data.tar.gz: 6bcbe7e3dea742dcfbcc45b125c77879b0a9d44783e49f88730207ea3594b5f438e9698cc0f398b29754d6749c64cd0a4b2b7fb7fb03b054b00c616cfae1606a

data/.gitignore

@@ -0,0 +1,14 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2015 Jason Kriss
+
+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,54 @@
+# BasicClient
+
+Helper library for writing faraday-based API wrappers.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'basic_client'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install basic_client
+
+## Usage
+
+```ruby
+class StripeClient < BasicClient::Base
+  with_base 'https://api.stripe.com'
+
+  def initialize(api_key)
+    @api_key = api_key
+  end
+
+  def charges
+    get('charges')
+  end
+
+  private
+  attr_reader :api_key
+
+  def path_prefix
+    'v1'
+  end
+
+  def set_request_middleware(connection)
+    connection.request :basic_auth, api_key, ''
+  end
+end
+```
+
+## Contributing
+
+1. Fork it ( https://github.com/jasonkriss/basic_client/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/basic_client.gemspec

@@ -0,0 +1,25 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'basic_client/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "basic_client"
+  spec.version       = BasicClient::VERSION
+  spec.authors       = ["Jason Kriss"]
+  spec.email         = ["jasonkriss@gmail.com"]
+  spec.summary       = %q{Helper library for writing faraday-based API wrappers.}
+  spec.homepage      = "https://github.com/jasonkriss/basic_client"
+  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.add_dependency 'faraday', '~> 0.8.9'
+  spec.add_dependency 'faraday_middleware', '~> 0.9.1'
+
+  spec.add_development_dependency "bundler", "~> 1.7"
+  spec.add_development_dependency "rake", "~> 10.0"
+end

data/lib/basic_client.rb

@@ -0,0 +1,9 @@
+require 'basic_client/version'
+require 'basic_client/base'
+require 'basic_client/errors'
+require 'basic_client/middleware/symbolized_json'
+require 'basic_client/middleware/raise_error'
+
+module BasicClient
+
+end

data/lib/basic_client/base.rb

@@ -0,0 +1,60 @@
+require 'faraday'
+require 'faraday_middleware'
+
+module BasicClient
+  class Base
+    class << self
+      attr_accessor :base_url
+
+      def with_base(url)
+        @base_url = url
+      end
+    end
+
+    def get(path, params = {}, headers = {}, &block)
+      request(:get, path, params, headers, &block)
+    end
+
+    def post(path, params = {}, headers = {}, &block)
+      request(:post, path, params, headers, &block)
+    end
+
+    def put(path, params = {}, headers = {}, &block)
+      request(:put, path, params, headers, &block)
+    end
+
+    def delete(path, params = {}, headers = {}, &block)
+      request(:delete, path, params, headers, &block)
+    end
+
+    private
+    def request(method, path, params, headers, &block)
+      response = connection.send(method, path, params, headers, &block)
+      response.body
+    end
+
+    def connection
+      @connection ||= build_connection
+    end
+
+    def build_connection
+      Faraday.new(self.class.base_url) do |connection|
+        connection.path_prefix = path_prefix if path_prefix
+        set_request_middleware(connection)
+        set_response_middleware(connection)
+        connection.adapter :net_http
+      end
+    end
+
+    def path_prefix; end
+
+    def set_request_middleware(connection)
+      connection.request :json
+    end
+
+    def set_response_middleware(connection)
+      connection.response :symbolized_json
+      connection.response :raise_error
+    end
+  end
+end

data/lib/basic_client/errors.rb

@@ -0,0 +1,13 @@
+module BasicClient
+  class Error < StandardError
+    attr_reader :status
+
+    def initialize(status, message)
+      @status = status
+      super(message)
+    end
+  end
+
+  ServerError = Class.new(Error)
+  ClientError = Class.new(Error)
+end

data/lib/basic_client/middleware/raise_error.rb

@@ -0,0 +1,21 @@
+require 'faraday'
+
+module BasicClient
+  module Middleware
+    class RaiseError < Faraday::Response::Middleware
+      def on_complete(env)
+        status = env[:status].to_i
+
+        error_class = if status.between?(400, 499)
+          BasicClient::ClientError
+        elsif status.between?(500, 599)
+          BasicClient::ServerError
+        end
+
+        raise error_class.new(status, env[:body]) if error_class
+      end
+    end
+  end
+end
+
+Faraday::Response.register_middleware :raise_error => BasicClient::Middleware::RaiseError

data/lib/basic_client/middleware/symbolized_json.rb

@@ -0,0 +1,30 @@
+require 'faraday'
+
+module BasicClient
+  module Middleware
+    class SymbolizedJson < Faraday::Response::Middleware
+      UNPARSABLE = [204, 301, 302, 304]
+
+      def parse(body)
+        case body
+        when /\A^\s*$\z/, nil
+          nil
+        else
+          try_parse(body)
+        end
+      end
+
+      def on_complete(env)
+        env[:body] = parse(env[:body]) unless UNPARSABLE.include?(env[:status])
+      end
+
+      def try_parse(body)
+        JSON.parse(body, symbolize_names: true)
+      rescue JSON::ParserError
+        body
+      end
+    end
+  end
+end
+
+Faraday::Response.register_middleware :symbolized_json => BasicClient::Middleware::SymbolizedJson

data/lib/basic_client/version.rb

@@ -0,0 +1,3 @@
+module BasicClient
+  VERSION = '0.1.0'
+end

metadata

@@ -0,0 +1,112 @@
+--- !ruby/object:Gem::Specification
+name: basic_client
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Jason Kriss
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-01-13 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: faraday
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.8.9
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.8.9
+- !ruby/object:Gem::Dependency
+  name: faraday_middleware
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.9.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.9.1
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+- !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'
+description: 
+email:
+- jasonkriss@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- basic_client.gemspec
+- lib/basic_client.rb
+- lib/basic_client/base.rb
+- lib/basic_client/errors.rb
+- lib/basic_client/middleware/raise_error.rb
+- lib/basic_client/middleware/symbolized_json.rb
+- lib/basic_client/version.rb
+homepage: https://github.com/jasonkriss/basic_client
+licenses:
+- MIT
+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.4.3
+signing_key: 
+specification_version: 4
+summary: Helper library for writing faraday-based API wrappers.
+test_files: []