clever-ruby 0.3.1 → 0.4.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 99033cb0c5a65221b812e16e8fe2fdfe9e72511e
+  data.tar.gz: 8ef75558e1f4cefdc30bc5e0d4f9549084535936
+SHA512:
+  metadata.gz: 45abc14b94d80f7b42703aeeeea9c1c682e9bcd966c9c70602d265fe3d5f96f2d5598421b532cac046004684b080086278953d1dcca67f83bbffcca8de2c9523
+  data.tar.gz: 9e5f17fce13546e08d25e6aef27591cf056828eb5535045d8e8948b5e15089dd0042d57371ad9c3e4dca18fb77d65f944f13e844091dd7fae072ff9d1baab8d1

data/.drone.yml

@@ -0,0 +1,14 @@
+image: ruby1.9.3
+script:
+  - bundle install
+  - bundle exec rake
+notify:
+  email:
+    recipients:
+      - drone@clever.com
+  hipchat:
+    room: Clever-Dev-CI
+    token: {{hipchatToken}}
+    on_started: true
+    on_success: true
+    on_failure: true

data/.rubocop.yml

@@ -0,0 +1,4 @@
+Metrics/LineLength:
+  Max: 100
+Metrics/MethodLength:
+  Max: 20

data/LICENSE

@@ -0,0 +1,190 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   Copyright 2014 Clever, Inc.
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

data/README.md

@@ -1,6 +1,6 @@
 # Clever::Ruby
 
-[![Build Status](https://travis-ci.org/Clever/clever-ruby.png)](https://travis-ci.org/Clever/clever-ruby)
+[![Build Status](https://drone.ops.clever.com/github.com/Clever/clever-ruby/status.svg?branch=master)](https://drone.ops.clever.com/github.com/Clever/clever-ruby)
 
 Ruby bindings to the Clever API.
 
@@ -8,23 +8,53 @@ Ruby bindings to the Clever API.
 
 Add this line to your application's Gemfile:
 
-    gem 'clever-ruby'
+```bash
+gem 'clever-ruby'
+```
 
 And then execute:
 
-    $ bundle
+```bash
+$ bundle
+```
 
 Or install it yourself as:
 
-    $ gem install clever-ruby
+```bash
+$ gem install clever-ruby
+```
+
+## Run tests
+
+To run all tests:
+
+```bash
+$ rake test
+```
+
+To run all tests and the linter ([rubocop](https://github.com/bbatsov/rubocop)):
+
+```bash
+$ rake
+```
+
+The linter follows the [Ruby Style Guide](https://github.com/bbatsov/ruby-style-guide) with a few exceptions. To just run the linter:
+
+```bash
+$ rake lint
+```
+
+Running specific tests is not currently supported.
 
 ## Usage
 
 Configure clever-ruby to use your Clever API key:
 
-    Clever.configure do |config|
-      config.api_key = 'YOUR-API-KEY'
-    end
+```ruby
+Clever.configure do |config|
+  config.api_key = 'YOUR-API-KEY'
+end
+```
 
 ## Contributing
 

data/Rakefile

@@ -9,8 +9,6 @@ Rake::TestTask.new(:test) do |test|
   test.verbose = true
 end
 
-task :default => :test
-
 require 'rdoc/task'
 require 'clever-ruby/version'
 Rake::RDocTask.new do |rdoc|
@@ -19,3 +17,15 @@ Rake::RDocTask.new do |rdoc|
   rdoc.rdoc_files.include('README*')
   rdoc.rdoc_files.include('lib/**/*.rb')
 end
+
+require 'rubocop/rake_task'
+
+desc 'Run RuboCop on the lib directory'
+RuboCop::RakeTask.new(:lint) do |task|
+  task.patterns = ['lib/**/*.rb', 'test/**/*.rb']
+end
+
+task default: [] do
+  Rake::Task[:test].execute
+  Rake::Task[:lint].execute
+end

data/clever-ruby.gemspec

@@ -2,29 +2,33 @@
 lib = File.expand_path('../lib', __FILE__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require 'clever-ruby/version'
+require 'English'
 
 Gem::Specification.new do |gem|
-  gem.name          = "clever-ruby"
+  gem.name          = 'clever-ruby'
   gem.version       = Clever::VERSION
-  gem.authors       = ["Clever Dev"]
-  gem.email         = ["tech-support@clever.com"]
-  gem.description   = %q{Ruby bindings to the Clever API.}
-  gem.summary       = %q{Ruby bindings to the Clever API.}
-  gem.homepage      = "http://github.com/Clever/clever-ruby"
+  gem.authors       = ['Clever Dev']
+  gem.email         = ['tech-support@clever.com']
+  gem.description   = 'Ruby bindings to the Clever API.'
+  gem.summary       = 'Ruby bindings to the Clever API.'
+  gem.homepage      = 'http://github.com/Clever/clever-ruby'
 
-  gem.files         = `git ls-files`.split($/)
-  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
-  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
-  gem.require_paths = ["lib"]
+  gem.required_ruby_version = '>= 1.9.3'
+  gem.files         = `git ls-files`.split($RS)
+  gem.executables   = gem.files.grep(/^bin\//).map { |f| File.basename f }
+  gem.test_files    = gem.files.grep(/^(test|spec|features)\//)
+  gem.require_paths = ['lib']
+
+  gem.add_runtime_dependency 'multi_json',    '~> 1.10.0'
+  gem.add_runtime_dependency 'rest-client',   '~> 1.6.7'
 
-  gem.add_runtime_dependency     'multi_json',    '~> 1.7.0'
-  gem.add_runtime_dependency     'rest-client',   '~> 1.6.7'
   gem.add_development_dependency 'rake'
   gem.add_development_dependency 'minitest',      '~> 4.4.0'
   gem.add_development_dependency 'shoulda',       '~> 3.3.2'
   gem.add_development_dependency 'rdoc',          '~> 3.12'
   gem.add_development_dependency 'vcr',           '~> 2.4.0'
   gem.add_development_dependency 'webmock',       '~> 1.9.0'
-  gem.add_development_dependency 'pry',           '~> 0.9.9.6'
+  gem.add_development_dependency 'pry',           '~> 0.10.1'
   gem.add_development_dependency 'activesupport', '~> 3.2.11'
+  gem.add_development_dependency 'rubocop',       '~> 0.26.0'
 end

data/lib/clever-ruby.rb

@@ -1,3 +1,4 @@
+# rubocop:disable FileName
 require 'rest_client'
 require 'multi_json'
 require 'open-uri'
@@ -33,6 +34,7 @@ require 'clever-ruby/errors/api_error'
 require 'clever-ruby/errors/authentication_error'
 require 'clever-ruby/errors/invalid_request_error'
 
+# Clever Ruby library
 module Clever
   class << self
     def configure
@@ -58,132 +60,156 @@ module Clever
 
   def self.convert_to_query_string(params = nil)
     if params && params.count
-      "?" + Util.flatten_params(params).collect { |p|
-        "#{URI::encode(p[0].to_s)}=#{URI::encode(p[1].to_s)}"
-      }.join('&')
+      params_arr = Util.flatten_params(params).map do |p|
+        "#{URI.encode(p[0].to_s)}=#{URI.encode(p[1].to_s)}"
+      end
+      '?' + params_arr.join('&')
     else
       ''
     end
   end
 
-  def self.request(method, url, params=nil, headers={})
-    raise AuthenticationError.new('No API key provided. (HINT: set your API key using "Clever.configure { |config| config.api_key = <API-KEY> }" or your token using "Clever.configure { |config| config.token = <TOKEN> }")') unless Clever.api_key or Clever.token
-
-    params = Util.objects_to_ids(params)
-    url = self.api_url(url)
-
+  def self.create_payload(method, url, params)
     case method.to_s.downcase.to_sym
     when :get, :head, :delete
-      url += convert_to_query_string(params)
+      url += convert_to_query_string params
       payload = nil
     else
       payload = params
     end
+    [url, payload]
+  end
 
-    if Clever.token
-      headers[:Authorization] = "Bearer " + Clever.token
-    end
+  def self.create_request_opts(method, url, params, headers)
+    params = Util.objects_to_ids params
+    url = api_url url
+    url, payload = create_payload method, url, params
+
+    headers[:Authorization] = 'Bearer ' + Clever.token if Clever.token
 
     opts = {
-      :method => method,
-      :url => url,
-      :headers => headers,
-      :open_timeout => 30,
-      :payload => payload,
-      :timeout => 80
+      method: method,
+      url: url,
+      headers: headers,
+      open_timeout: 30,
+      payload: payload,
+      timeout: 120
     }
     if Clever.api_key
       opts[:user] = Clever.api_key
-      opts[:password] = ""
+      opts[:password] = ''
     end
+    opts
+  end
 
-    begin
-      response = execute_request(opts)
-    rescue SocketError => e
-      self.handle_restclient_error(e)
-    rescue NoMethodError => e
-      # Work around RestClient bug
-      if e.message =~ /\WRequestFailed\W/
-        e = APIConnectionError.new('Unexpected HTTP response code')
-        self.handle_restclient_error(e)
-      else
-        raise
-      end
-    rescue RestClient::ExceptionWithResponse => e
-      if rcode = e.http_code and rbody = e.http_body
-        self.handle_api_error(rcode, rbody)
-      else
-        self.handle_restclient_error(e)
-      end
-    rescue RestClient::Exception, Errno::ECONNREFUSED => e
-      self.handle_restclient_error(e)
+  def self.check_authorization
+    unless Clever.api_key || Clever.token
+      fail AuthenticationError, 'No API key provided. (HINT: set your API key using '\
+        '"Clever.configure { |config| config.api_key = <API-KEY> }" or your token using '\
+        '"Clever.configure { |config| config.token = <TOKEN> }")'
     end
+  end
+
+  def self.request(method, url, params = nil, headers = {})
+    check_authorization
+    opts = create_request_opts method, url, params, headers
+    response = execute_request opts
 
     rbody = response.body
     rcode = response.code
     begin
-      # Would use :symbolize_names => true, but apparently there is
+      # Would use symbolize_names: true, but apparently there is
       # some library out there that makes symbolize_names not work.
-      resp = Clever::JSON.load(rbody)
+      resp = Clever::JSON.load rbody
     rescue MultiJson::DecodeError
-      raise APIError.new("Invalid response object from API: #{rbody.inspect} (HTTP response code was #{rcode})", rcode, rbody)
+      raise APIError.new(
+        "Invalid response object from API: #{rbody.inspect} (HTTP response code was #{rcode})",
+        rcode, rbody)
     end
 
-    resp = Util.symbolize_names(resp)
+    resp = Util.symbolize_names resp
     resp
   end
 
   private
 
   def self.execute_request(opts)
-    RestClient::Request.execute(opts)
+    begin
+      request = RestClient::Request.execute opts
+    rescue SocketError => e
+      handle_restclient_error e
+    rescue NoMethodError => e
+      # TODO: investigate
+      # Work around RestClient bug
+      if e.message =~ /\WRequestFailed\W/
+        handle_restclient_error APIConnectionError.new 'Unexpected HTTP response code'
+      else raise
+      end
+    rescue RestClient::ExceptionWithResponse => e
+      rcode = e.http_code
+      rbody = e.http_body
+      if rcode && rbody
+        handle_api_error rcode, rbody
+      else handle_restclient_error e
+      end
+    rescue RestClient::Exception, Errno::ECONNREFUSED => e
+      handle_restclient_error e
+    end
+
+    request
   end
 
   def self.handle_restclient_error(e)
     case e
     when RestClient::ServerBrokeConnection, RestClient::RequestTimeout
-      message = "Could not connect to Clever (#{configuration.api_base}). Please check your internet connection and try again."
+      message = "Could not connect to Clever (#{configuration.api_base}). " \
+      'Please check your internet connection and try again.'
     when SocketError
-      message = "Unexpected error communicating when trying to connect to Clever. HINT: You may be seeing this message because your DNS is not working. To check, try running 'host api.clever.com' from the command line."
+      message = 'Unexpected error communicating when trying to connect to Clever. HINT: ' \
+        'You may be seeing this message because your DNS is not working. To check, try running ' \
+        "'host api.clever.com' from the command line."
     else
-      message = "Unexpected error communicating with Clever."
+      message = 'Unexpected error communicating with Clever.'
     end
     message += "\n\n(Network error: #{e.message})"
-    raise APIConnectionError.new(message)
+    fail APIConnectionError, message
   end
 
   def self.handle_api_error(rcode, rbody)
     begin
-      error_obj = Clever::JSON.load(rbody)
-      error_obj = Util.symbolize_names(error_obj)
-      error = error_obj[:error] or raise StripeError.new # escape from parsing
-    rescue MultiJson::DecodeError, StripeError
-      raise APIError.new("Invalid response object from API: #{rbody.inspect} (HTTP response code was #{rcode})", rcode, rbody)
+      error_obj = Clever::JSON.load rbody
+      error_obj = Util.symbolize_names error_obj
+      error = error_obj[:error]
+      fail CleverError unless error # escape from parsing
+    rescue MultiJson::DecodeError, CleverError
+      raise APIError.new(
+        "Invalid response object from API: #{rbody.inspect} (HTTP response code was #{rcode})",
+        rcode, rbody)
     end
 
     case rcode
     when 400, 404 then
-      raise invalid_request_error(error, rcode, rbody, error_obj)
+      fail invalid_request_error error, rcode, rbody, error_obj
     when 401
-      raise authentication_error(error, rcode, rbody, error_obj)
+      fail authentication_error error, rcode, rbody, error_obj
     else
-      raise api_error(error, rcode, rbody, error_obj)
+      fail api_error error, rcode, rbody, error_obj
     end
   end
 
   def self.invalid_request_error(error, rcode, rbody, error_obj)
     if error.is_a? Hash
-      InvalidRequestError.new(error[:message], error[:param], rcode, rbody, error_obj)
+      InvalidRequestError.new error[:message], error[:param], rcode, rbody, error_obj
     else
-      InvalidRequestError.new(error, '', rcode, rbody, error_obj)
+      InvalidRequestError.new error, '', rcode, rbody, error_obj
     end
   end
 
   def self.authentication_error(error, rcode, rbody, error_obj)
-    AuthenticationError.new(error[:message], rcode, rbody, error_obj)
+    AuthenticationError.new error[:message], rcode, rbody, error_obj
   end
 
   def self.api_error(error, rcode, rbody, error_obj)
-    APIError.new(error[:message], rcode, rbody, error_obj)
+    APIError.new error[:message], rcode, rbody, error_obj
   end
 end