api_client 0.5.24 → 0.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 385e45c6ce100a69210fe4d2134474aa6e8c546e
-  data.tar.gz: da024da3eba27eec82941d61ad102f68894fb39a
+SHA256:
+  metadata.gz: 65b639c41de486bf27f118c1d6d3860b77e582d1fd03213801744e5e985938af
+  data.tar.gz: 7c774f56f8d550c49586ab2a1237db52bf052c0122058393566cc4f36cb8636a
 SHA512:
-  metadata.gz: d0452079acaee8c38f138be81345ceb4a6462f0d676b26b382fea91960c3601aa89655ec7abf96e0620e954161be79c026600933030072077c8b996482c60bf9
-  data.tar.gz: d41eff230b1487ab49b9706f567e03ffd0c1f70f4dc158632358473fda215f9409dd4b25ed53af28d8246c161858cb047fa0e13876ade16bcb9a6ae9028bccef
+  metadata.gz: 3f2fb5535e7b62aae77d2947a7e97cf1ea58506ed7348b839864194a6d6ac4aac5222011cedb095fa16a972be3e0835bae5e6269d29f1836f02edc6ffbe3a7be
+  data.tar.gz: 1d85041923882d0713a2f065e25484ac4ad8992f68085a9f24296b11b6b92bdc791b3de5b44a5ed6e5dc2be520d5b5a7c9d3c5f441466fc2d082ea3ac6ffeb9f

data/CHANGELOG.md

@@ -1,3 +1,16 @@
+# 0.6.0
+
+* Add support for faraday gem version >= 1.0.0 and < 2.0.0
+* Drop support for Ruby < 2.3
+
+# 0.5.26
+
+* Add support for HTTP status code: 412 Precondition Failed
+
+# 0.5.25
+
+* Fix broken gem build (gemspec files)
+
 # 0.5.23
 
 * Add support for HTTP status code: 423 Locked

data/LICENSE

@@ -186,7 +186,7 @@
       same "printed page" as the copyright notice for easier
       identification within third-party archives.
 
-   Copyright 2020 Zendesk
+   Copyright 2011 Zendesk
 
    Licensed under the Apache License, Version 2.0 (the "License");
    you may not use this file except in compliance with the License.

data/README.md

@@ -1,4 +1,4 @@
-ApiClient [![Build Status](https://travis-ci.org/futuresimple/api_client.svg?branch=master)](https://travis-ci.org/futuresimple/api_client)
+ApiClient ![Tests](https://github.com/zendesk/api_client/workflows/Tests/badge.svg)
 =========
 
 ApiClient is an experimental builder for HTTP API clients. The goal is to provide a easy to use engine for constructing queries and map the responses to instances of Hashie::Mash subclasses.
@@ -154,8 +154,14 @@ ApiClient.logger.level = Logger::INFO
 
 ```
 
+## Releasing new version of gem
+
+1. Update version in [lib/api_client/version.rb](lib/api_client/version.rb) and push to `master`
+2. Create new GitHub release with tag name starting with `v` and the version, for example `v1.0.0`
+3. Gem will be automatically built and pushed to rubygems.org with GitHub Action
+
 ## Copyright and license
 
-Copyright 2020 Zendesk
+Copyright 2011 Zendesk
 
 Licensed under the [Apache License, Version 2.0](LICENSE)

data/lib/api_client/connection/basic.rb

@@ -88,7 +88,7 @@ module ApiClient
         response = @handler.send(method, path, data, headers)
         request = { :method => method, :path => path, :data => data}
         handle_response(request, response)
-      rescue Faraday::Error::ConnectionFailed => e
+      rescue Faraday::ConnectionFailed => e
         raise ApiClient::Errors::ConnectionFailed.new(e.message, request, response)
       end
 
@@ -109,6 +109,8 @@ module ApiClient
             raise ApiClient::Errors::Conflict.new(nil, request, response)
           when 410
             raise ApiClient::Errors::Gone.new(nil, request, response)
+          when 412
+            raise ApiClient::Errors::PreconditionFailed.new(nil, request, response)
           when 422
             raise ApiClient::Errors::UnprocessableEntity.new(response.body, request, response)
           when 423

data/lib/api_client/errors.rb

@@ -24,6 +24,7 @@ module ApiClient
     class Gone < ApiClientError; end
     class ServerError < ApiClientError; end
     class UnprocessableEntity < ApiClientError; end
+    class PreconditionFailed < ApiClientError; end
     class Locked < ApiClientError; end
     class TooManyRequests < ApiClientError; end
   end

data/lib/api_client/version.rb

@@ -1,3 +1,3 @@
 module ApiClient
-  VERSION = '0.5.24'
+  VERSION = '0.6.0'
 end

data/spec/api_client/connection/basic_spec.rb

@@ -7,21 +7,21 @@ describe ApiClient::Connection::Basic do
     instance.inspect.should == '#<ApiClient::Connection::Basic endpoint: "http://google.com">'
   end
 
+  it "uses correct adapter" do
+    instance = ApiClient::Connection::Basic.new("http://google.com")
+    expect(instance.handler.builder.adapter.name).to eq("Faraday::Adapter::NetHttp")
+  end
+
   it "adds basic middlewares to faraday" do
     instance = ApiClient::Connection::Basic.new("http://google.com")
-    instance.handler.builder.handlers.collect(&:name).should == ["Faraday::Request::UrlEncoded", "Faraday::Adapter::NetHttp"]
+    expect(instance.handler.builder.handlers.collect(&:name)).to include("Faraday::Request::UrlEncoded")
   end
 
   it "adds the logger middlewares to faraday if ApiClient.logger is available" do
     logger = double
     ApiClient.stub(:logger).and_return(logger)
     instance = ApiClient::Connection::Basic.new("http://google.com")
-    instance.handler.builder.handlers.collect(&:name).should == [
-      "ApiClient::Connection::Middlewares::Request::Logger",
-      "Faraday::Request::UrlEncoded",
-      "Faraday::Adapter::NetHttp"
-    ]
-
+    expect(instance.handler.builder.handlers.collect(&:name)).to include("ApiClient::Connection::Middlewares::Request::Logger", "Faraday::Request::UrlEncoded")
   end
 
   it "creates a Faraday object on initialize" do
@@ -149,6 +149,13 @@ describe ApiClient::Connection::Basic do
       }.should raise_error(ApiClient::Errors::Gone, "Status code: 410")
     end
 
+    it "raises an ApiClient::Errors::PreconditionFailed if status is 412" do
+      @response.env[:status] = 412
+      lambda {
+        @instance.send :handle_response, request, @response
+      }.should raise_error(ApiClient::Errors::PreconditionFailed, "Status code: 412")
+    end
+
     it "raises an ApiClient::Errors::Unsupported if status is 422" do
       @response.env[:status] = 422
       lambda {

data/spec/api_client/connection/oauth_spec.rb

@@ -2,26 +2,22 @@ require "spec_helper"
 
 describe ApiClient::Connection::Oauth do
 
+  it "uses correct adapter" do
+    instance = ApiClient::Connection::Oauth.new("http://google.com")
+    expect(instance.handler.builder.adapter.name).to eq("Faraday::Adapter::NetHttp")
+  end
+
   it "adds basic middlewares to faraday" do
     instance = ApiClient::Connection::Oauth.new("http://google.com")
-    instance.handler.builder.handlers.collect(&:name).should == [
-      "ApiClient::Connection::Middlewares::Request::OAuth",
-      "Faraday::Request::UrlEncoded",
-      "Faraday::Adapter::NetHttp"
-    ]
+    expect(instance.handler.builder.handlers.collect(&:name))
+      .to include("ApiClient::Connection::Middlewares::Request::OAuth", "Faraday::Request::UrlEncoded")
   end
 
   it "adds the logger middlewares to faraday if ApiClient.logger is available" do
     logger = double
     ApiClient.stub(:logger).and_return(logger)
     instance = ApiClient::Connection::Oauth.new("http://google.com")
-    instance.handler.builder.handlers.collect(&:name).should == [
-      "ApiClient::Connection::Middlewares::Request::Logger",
-      "ApiClient::Connection::Middlewares::Request::OAuth",
-      "Faraday::Request::UrlEncoded",
-      "Faraday::Adapter::NetHttp"
-    ]
-
+    expect(instance.handler.builder.handlers.collect(&:name))
+      .to include("ApiClient::Connection::Middlewares::Request::Logger", "ApiClient::Connection::Middlewares::Request::OAuth", "Faraday::Request::UrlEncoded")
   end
-
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: api_client
 version: !ruby/object:Gem::Version
-  version: 0.5.24
+  version: 0.6.0
 platform: ruby
 authors:
 - Zendesk
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-04-22 00:00:00.000000000 Z
+date: 2022-05-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
@@ -61,7 +61,7 @@ dependencies:
         version: 0.8.1
     - - "<"
       - !ruby/object:Gem::Version
-        version: 1.0.0
+        version: 2.0.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -71,7 +71,7 @@ dependencies:
         version: 0.8.1
     - - "<"
       - !ruby/object:Gem::Version
-        version: 1.0.0
+        version: 2.0.0
 - !ruby/object:Gem::Dependency
   name: multi_json
   requirement: !ruby/object:Gem::Requirement
@@ -93,22 +93,12 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- ".gitignore"
-- ".rspec"
-- ".travis.yml"
 - CHANGELOG.md
 - Gemfile
 - LICENSE
 - Makefile
 - README.md
 - Rakefile
-- api_client.gemspec
-- examples/digg.rb
-- examples/flickr.rb
-- examples/github.rb
-- examples/highrise.rb
-- examples/twitter.rb
-- examples/twitter_oauth.rb
 - lib/api_client.rb
 - lib/api_client/base.rb
 - lib/api_client/connection/abstract.rb
@@ -164,15 +154,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 2.3.8
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: api_client
-rubygems_version: 2.5.2.3
+rubygems_version: 3.4.0.dev
 signing_key: 
 specification_version: 3
 summary: API client builder

data/.gitignore

@@ -1,9 +0,0 @@
-*.gem
-.bundle
-Gemfile.lock
-pkg/*
-bin
-coverage
-examples/config.rb
-*.sw[a-z]
-.idea/*

data/.rspec

@@ -1 +0,0 @@
---color

data/.travis.yml

@@ -1,13 +0,0 @@
-language: ruby
-before_install:
-  - gem install bundler -v 1.11.2
-script: bundle exec rspec spec
-rvm:
-  - jruby-1.7.2
-  - 1.9.3
-  - 2.1.9
-  - 2.2.10
-  - 2.3.8
-  - 2.4.6
-  - 2.5.5
-  - 2.6.3

data/api_client.gemspec

@@ -1,49 +0,0 @@
-# -*- encoding: utf-8 -*-
-$:.push File.expand_path("../lib", __FILE__)
-require "api_client/version"
-
-Gem::Specification.new do |s|
-  s.name        = "api_client"
-  s.version     = ApiClient::VERSION
-  s.authors     = ["Zendesk"]
-  s.email       = ["opensource@zendesk.com"]
-  s.homepage    = "https://github.com/futuresimple/api_client"
-  s.summary     = %q{API client builder}
-  s.description = %q{API client builder}
-  s.license     = "Apache License Version 2.0"
-
-  s.rubyforge_project = "api_client"
-
-  # Declare runtime dependencies here:
-  def s.add_runtime_dependencies(method)
-    if RUBY_PLATFORM == "java"
-      send method, 'jrjackson'
-    else
-      send method, 'yajl-ruby'
-    end
-
-    send method, 'hashie', [">= 2.0.5"]
-    send method, 'faraday', [">= 0.8.1", "< 1.0.0"]
-    send method, 'multi_json', [">= 1.6.1"]
-  end
-
-  # Declare development dependencies here:
-  s.add_development_dependency 'rspec', '2.14.1'
-
-  if s.respond_to? :specification_version then
-    s.specification_version = 3
-
-    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
-      s.add_runtime_dependencies(:add_runtime_dependency)
-    else
-      s.add_runtime_dependencies(:add_dependency)
-    end
-  else
-    s.add_runtime_dependencies(:add_dependency)
-  end
-
-  s.files         = `git ls-files`.split("\n")
-  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
-  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
-  s.require_paths = ["lib"]
-end

data/examples/digg.rb

@@ -1,31 +0,0 @@
-require "rubygems"
-require "bundler/setup"
-require "api_client"
-
-module Digg
-
-  class Base < ApiClient::Base
-
-    always do
-      endpoint "http://services.digg.com"
-      params   :type => 'json'
-    end
-
-  end
-
-  class Collection < Base
-
-    def self.diggs
-      Digg.build get('/2.0/digg.getAll')['diggs']
-    end
-
-  end
-
-  class Digg < Base
-  end
-
-end
-
-Digg::Collection.diggs.each do |digg|
-  puts "#{digg.user.name}: #{digg.item.title}"
-end

data/examples/flickr.rb

@@ -1,37 +0,0 @@
-require "rubygems"
-require "bundler/setup"
-require "./examples/config" if File.exists?('examples/config.rb')
-require "api_client"
-
-module Flickr
-
-  class Base < ApiClient::Base
-    always do
-      endpoint "http://api.flickr.com"
-      params   :api_key => FLICKR_API_KEY,
-               :format => 'json',
-               :nojsoncallback => 1
-    end
-  end
-
-  class Collection < Base
-
-    def self.interesting
-      build params(:method => 'flickr.interestingness.getList').
-            get("/services/rest")
-    end
-
-    def photos
-      Photo.build self['photos']['photo']
-    end
-
-  end
-
-  class Photo < Base
-  end
-
-end
-
-Flickr::Collection.interesting.photos.each do |photo|
-  puts photo.title
-end

data/examples/github.rb

@@ -1,52 +0,0 @@
-require "rubygems"
-require "bundler/setup"
-require "./examples/config" if File.exists?('examples/config.rb')
-require "api_client"
-require "time"
-
-module Github
-
-  class Base < ApiClient::Base
-    namespace false
-
-    always do
-      endpoint "https://api.github.com"
-    end
-  end
-
-  class User < Base
-
-    def self.find(name)
-      fetch("/users/#{name}")
-    end
-
-    def events
-      Github::Event.fetch("/users/#{login}/events")
-    end
-
-    def received_events
-      Github::Event.fetch("/users/#{login}/received_events")
-    end
-
-  end
-
-  class Event < Base
-
-    def created_at
-      Time.parse self['created_at']
-    end
-
-  end
-
-end
-
-user = Github::User.find("marcinbunsch")
-
-user.events.each do |event|
-  case event.type
-    when "FollowEvent"
-      puts "#{event.created_at} #{event.payload.target.login}: #{event.type}"
-    else
-      puts "#{event.created_at} #{event.repo.name} : #{event.type}"
-    end
-end

data/examples/highrise.rb

@@ -1,41 +0,0 @@
-require "rubygems"
-require "bundler/setup"
-require "./examples/config" if File.exists?('examples/config.rb')
-require "api_client"
-require "multi_xml"
-
-module Highrise
-
-  class Base < ApiClient::Resource::Base
-    format      :xml
-
-    # In this hook we set the basic auth provided in the options
-    connection do |connection|
-      connection.handler.basic_auth connection.options[:user], connection.options[:pass]
-    end
-
-    always do
-      endpoint HIGHRISE_URL
-      options(:user => HIGHRISE_TOKEN, :pass => 'X')
-    end
-
-  end
-
-  class Person < Base
-    namespace false
-
-    always do
-      path "people"
-    end
-
-    def self.build_one(hash)
-      hash.has_key?('people') ? build_many(hash['people']) : super(hash)
-    end
-
-  end
-
-end
-
-Highrise::Person.find_all.each do |person|
-  puts "#{person.first_name} #{person.last_name}"
-end

data/examples/twitter.rb

@@ -1,34 +0,0 @@
-require "rubygems"
-require "bundler/setup"
-require "api_client"
-
-module Twitter
-
-  class Base < ApiClient::Base
-    always do
-      endpoint    "http://api.twitter.com/"
-    end
-  end
-
-  class Tweet < Base
-  end
-
-  class User < Base
-
-    def self.find_by_username(name)
-      params(:screen_name => name).fetch("/1/users/show.json")
-    end
-
-    def tweets
-      Tweet.params(:screen_name => self.screen_name).fetch("/1/statuses/user_timeline.json")
-    end
-
-  end
-
-end
-
-user = Twitter::User.find_by_username("marcinbunsch")
-puts user.name
-user.tweets.each do |tweet|
-  puts "  #{tweet.text}"
-end

data/examples/twitter_oauth.rb

@@ -1,36 +0,0 @@
-require "rubygems"
-require "bundler/setup"
-require "./examples/config" if File.exists?('examples/config.rb')
-require "api_client"
-
-module TwitterOauth
-
-  class Base < ApiClient::Base
-
-    always do
-      endpoint "https://api.twitter.com/"
-      adapter  :oauth
-
-      options  :oauth => {
-        :consumer_key => TWITTER_CONSUMER_KEY, :consumer_secret => TWITTER_CONSUMER_SECRET
-      }
-
-    end
-
-  end
-
-  class Tweet < Base
-
-    def self.tweet(message)
-      build post('/1/statuses/update.json', :status => message)
-    end
-
-  end
-
-end
-
-config = { :token => TWITTER_TOKEN, :token_secret => TWITTER_SECRET }
-
-message = TwitterOauth::Tweet.options(:oauth => config).tweet("test #{Time.now.to_i}")
-
-puts message.text