api_client 0.5.24-java → 0.6.0-java

data/spec/api_client/connection/abstract_spec.rb

@@ -0,0 +1,21 @@
+require "spec_helper"
+
+describe ApiClient::Connection::Abstract do
+
+  class ConnectionSubclass < ApiClient::Connection::Abstract
+  end
+
+  it "does not raise an error when instantiating a subclass" do
+    lambda {
+      ConnectionSubclass.new("http://google.com")
+    }.should_not raise_error()
+  end
+
+  it "raises an error when instantiating directly and not as a subclass" do
+    lambda {
+      ApiClient::Connection::Abstract.new("http://google.com")
+    }.should raise_error("Cannot instantiate abstract class")
+  end
+
+end
+

data/spec/api_client/connection/basic_spec.rb

@@ -0,0 +1,198 @@
+require "spec_helper"
+
+describe ApiClient::Connection::Basic do
+
+  it "has a nice inspect" do
+    instance = ApiClient::Connection::Basic.new("http://google.com")
+    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")
+    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")
+    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
+    instance = ApiClient::Connection::Basic.new("http://google.com")
+    instance.handler.should be_an_instance_of(Faraday::Connection)
+  end
+
+  describe "requests" do
+
+    before do
+      @instance = ApiClient::Connection::Basic.new("http://google.com")
+      @headers  = { "header" => "token" }
+      @params   = { "param" => "1", "nested" => { "param" => "1" } }
+      @response = Faraday::Response.new(:status => 200)
+      @faraday_request_params = double
+      @faraday_request = double(:params => @faraday_request_params)
+    end
+
+    it "can perform GET requests" do
+      @instance.handler.
+        should_receive(:run_request).
+        with(:get, '/home', nil, @headers).
+        and_yield(@faraday_request).
+        and_return(@response)
+      @faraday_request_params.should_receive(:update).with(@params)
+      @instance.get "/home", @params, @headers
+    end
+
+    it "can perform POST requests" do
+      @instance.handler.
+        should_receive(:run_request).
+        with(:post, '/home', @params, @headers).
+        and_return(@response)
+      @instance.post "/home", @params, @headers
+    end
+
+    it "can perform PATCH requests" do
+      @instance.handler.
+        should_receive(:run_request).
+        with(:patch, '/home', @params, @headers).
+        and_return(@response)
+      @instance.patch "/home", @params, @headers
+    end
+
+    it "can perform PUT requests" do
+      @instance.handler.
+        should_receive(:run_request).
+        with(:put, '/home', @params, @headers).
+        and_return(@response)
+      @instance.put "/home", @params, @headers
+    end
+
+    it "can perform DELETE requests" do
+      @instance.handler.
+        should_receive(:run_request).
+        with(:delete, '/home', nil, @headers).
+        and_yield(@faraday_request).
+        and_return(@response)
+      @faraday_request_params.should_receive(:update).with(@params)
+      @instance.delete "/home", @params, @headers
+    end
+
+  end
+
+  describe "#handle_response" do
+    let(:request) { double }
+
+    before do
+      @instance = ApiClient::Connection::Basic.new("http://google.com")
+      @response = Faraday::Response.new(:status => 200)
+    end
+
+    it "raises an ApiClient::Errors::ConnectionFailed if there is no response" do
+      lambda {
+        @instance.send :handle_response, request, nil
+      }.should raise_error(ApiClient::Errors::ConnectionFailed, "ApiClient::Errors::ConnectionFailed")
+    end
+
+    it "raises an ApiClient::Errors::Unauthorized if status is 401" do
+      @response.env[:status] = 401
+      lambda {
+        @instance.send :handle_response, request, @response
+      }.should raise_error(ApiClient::Errors::Unauthorized, "Status code: 401")
+    end
+
+    it "raises an ApiClient::Errors::Forbidden if status is 403" do
+      @response.env[:status] = 403
+      lambda {
+        @instance.send :handle_response, request, @response
+      }.should raise_error(ApiClient::Errors::Forbidden, "Status code: 403")
+    end
+
+    it "raises an ApiClient::Errors::NotFound if status is 404" do
+      @response.env[:status] = 404
+      lambda {
+        @instance.send :handle_response, request, @response
+      }.should raise_error(ApiClient::Errors::NotFound, "Status code: 404")
+    end
+
+    it "raises an ApiClient::Errors::BadRequest if status is 400" do
+      @response.env[:status] = 400
+      lambda {
+        @instance.send :handle_response, request, @response
+      }.should raise_error(ApiClient::Errors::BadRequest, "Status code: 400")
+    end
+
+    it "raises an ApiClient::Errors::Unsupported if status is 406" do
+      @response.env[:status] = 406
+      lambda {
+        @instance.send :handle_response, request, @response
+      }.should raise_error(ApiClient::Errors::Unsupported, "Status code: 406")
+    end
+
+    it "raises an ApiClient::Errors::Conflict if status is 409" do
+      @response.env[:status] = 409
+      lambda {
+        @instance.send :handle_response, request, @response
+      }.should raise_error(ApiClient::Errors::Conflict, "Status code: 409")
+    end
+
+    it "raises an ApiClient::Errors::Gone if status is 410" do
+      @response.env[:status] = 410
+      lambda {
+        @instance.send :handle_response, request, @response
+      }.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 {
+        @instance.send :handle_response, request, @response
+      }.should raise_error(ApiClient::Errors::UnprocessableEntity, @response.body)
+    end
+
+    it "raises an ApiClient::Errors::Locked if status is 423" do
+      @response.env[:status] = 423
+      lambda {
+        @instance.send :handle_response, request, @response
+      }.should raise_error(ApiClient::Errors::Locked, @response.body)
+    end
+
+    it "raises an ApiClient::Errors::TooManyRequests if status is 429" do
+      @response.env[:status] = 429
+      lambda {
+        @instance.send :handle_response, request, @response
+      }.should raise_error(ApiClient::Errors::TooManyRequests, @response.body)
+    end
+
+    it "raises an ApiClient::Errors::Unsupported if status is 300..399" do
+      location = "https://google.com"
+      @response.env[:status] = 302
+      @response.env[:response_headers] = { 'Location' => location }
+      lambda {
+        @instance.send :handle_response, request, @response
+      }.should raise_error(ApiClient::Errors::Redirect, location)
+    end
+
+    it "raises an ApiClient::Errors::ServerError if status is 500..599" do
+      @response.env[:status] = 502
+      lambda {
+        @instance.send :handle_response, request, @response
+      }.should raise_error(ApiClient::Errors::ServerError, "Status code: 502")
+    end
+
+  end
+
+end

data/spec/api_client/connection/oauth_spec.rb

@@ -0,0 +1,23 @@
+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")
+    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")
+    expect(instance.handler.builder.handlers.collect(&:name))
+      .to include("ApiClient::Connection::Middlewares::Request::Logger", "ApiClient::Connection::Middlewares::Request::OAuth", "Faraday::Request::UrlEncoded")
+  end
+end

data/spec/api_client/connection/request/json_spec.rb

@@ -0,0 +1,30 @@
+require "spec_helper"
+
+describe ApiClient::Connection::Middlewares::Request::Json do
+  let(:app) { double }
+  let(:body) { {:some => :data} }
+  let(:env) do
+    {
+      :url => "http://api.twitter.com",
+      :request_headers => {},
+      :method => "post",
+      :body => body
+    }
+  end
+
+  subject { ApiClient::Connection::Middlewares::Request::Json.new(app) }
+
+  it "sets content type to json" do
+    app.should_receive(:call).
+      with(hash_including(:request_headers => {"Content-Type" => "application/json"}))
+
+    subject.call(env)
+  end
+
+  it "JSON encodes body" do
+    app.should_receive(:call).
+      with(hash_including(:body => MultiJson.dump(body)))
+
+    subject.call(env)
+  end
+end

data/spec/api_client/connection/request/logger_spec.rb

@@ -0,0 +1,18 @@
+require "spec_helper"
+
+describe ApiClient::Connection::Middlewares::Request::Logger do
+  it "adds a oauth header to the request" do
+    app = double
+    io = StringIO.new
+    logger = Logger.new(io)
+    instance = ApiClient::Connection::Middlewares::Request::Logger.new(app, logger)
+    env = {
+      :url => "http://api.twitter.com",
+      :request_headers => {},
+      :method => 'get'
+    }
+    app.should_receive(:call).with(env)
+    instance.call(env)
+    io.string.should match("GET http://api.twitter.com")
+  end
+end

data/spec/api_client/connection/request/oauth_spec.rb

@@ -0,0 +1,26 @@
+require "spec_helper"
+
+describe ApiClient::Connection::Middlewares::Request::OAuth do
+
+  it "adds a oauth header to the request" do
+    app = double
+    options = {
+      :token => 'TOKEN',
+      :token_secret => 'SECRET',
+      :consumer_key => 'CONSUMER_KEY',
+      :consumer_secret => 'CONSUMER_SECRET'
+    }
+    instance = ApiClient::Connection::Middlewares::Request::OAuth.new(app, options)
+    env = {
+      :url => "http://api.twitter.com",
+      :request_headers => {}
+    }
+    app.should_receive(:call).with(env)
+
+    instance.call(env)
+    env[:request_headers]['Authorization'].should match("OAuth")
+    env[:request_headers]['User-Agent'].should match("ApiClient gem")
+
+  end
+
+end

data/spec/api_client/resource/base_spec.rb

@@ -0,0 +1,97 @@
+require "spec_helper"
+
+describe ApiClient::Resource::Base do
+
+  describe '.scope' do
+
+    it "is an instance of ApiClient::Resource::Scope" do
+      ApiClient::Resource::Base.scope.should be_an_instance_of(ApiClient::Resource::Scope)
+    end
+
+  end
+
+
+  describe "persistence" do
+
+    before do
+      @instance = ApiClient::Resource::Base.new
+      @instance.id = 42
+      @instance.name = "Mike"
+    end
+
+    describe '#persisted?' do
+
+      it "returns true if id is present, false otherwise" do
+        @instance.id = 42
+        @instance.persisted?.should == true
+        @instance.id = nil
+        @instance.persisted?.should == false
+      end
+
+    end
+
+    describe '#save' do
+
+      it "creates a record if not persisted" do
+        @instance.id = nil
+        @instance.should_receive(:remote_create)
+        @instance.save
+      end
+
+      it "updates a record if not persisted" do
+        @instance.id = 42
+        @instance.should_receive(:remote_update)
+        @instance.save
+      end
+
+    end
+
+    describe "#destroy" do
+
+      it "delegates the destroy to the class" do
+        ApiClient::Resource::Base.should_receive(:destroy).with(42)
+        @instance.destroy
+      end
+
+      it "retains the original scope" do
+        @instance.original_scope = double
+        @instance.original_scope.should_receive(:destroy).with(42)
+        @instance.destroy
+      end
+
+    end
+
+    describe "#remote_update" do
+
+      it "delegates the update to the class" do
+        ApiClient::Resource::Base.should_receive(:update).with(42, "name" => "Mike")
+        @instance.remote_update
+      end
+
+      it "retains the original scope" do
+        ApiClient::Resource::Base.stub(:update)
+        @instance.original_scope = double
+        @instance.original_scope.should_receive(:update).with(42, "name" => "Mike")
+        @instance.remote_update
+      end
+
+    end
+
+    describe "#remote_create" do
+
+      it "delegates the create to the class" do
+        ApiClient::Resource::Base.should_receive(:create).with("name" => "Mike")
+        @instance.remote_create
+      end
+
+      it "retains the original scope" do
+        @instance.original_scope = double
+        @instance.original_scope.should_receive(:create).with("name" => "Mike")
+        @instance.remote_create
+      end
+
+    end
+
+  end
+
+end

data/spec/api_client/resource/name_spec.rb

@@ -0,0 +1,19 @@
+require 'spec_helper'
+
+describe ApiClient::Resource::NameResolver do
+  describe '.resolve' do
+    subject { described_class }
+
+    it 'changes My::Namespace::MyResouce to my_resource' do
+      subject.resolve('My::Namespace::MyResource').should == 'my_resource'
+    end
+
+    it 'changes Resource to resource' do
+      subject.resolve('Resource').should == 'resource'
+    end
+
+    it 'changes My::Resource to resoure' do
+      subject.resolve('My::Resource').should == 'resource'
+    end
+  end
+end

data/spec/api_client/resource/scope_spec.rb

@@ -0,0 +1,122 @@
+require "spec_helper"
+
+describe ApiClient::Resource::Scope do
+
+  describe "restful requests" do
+
+    class Restful < ApiClient::Resource::Base
+    end
+
+    class Restful2 < ApiClient::Resource::Base
+      namespace false
+    end
+
+    class Restful3 < ApiClient::Resource::Base
+      prefix "v1"
+    end
+
+    before do
+      @instance  = ApiClient::Resource::Scope.new(Restful)
+    end
+
+    it "performs a find to fetch one record" do
+      response = { "restful" => { "id" => 42 }}
+      @instance.should_receive(:get).with('/restfuls/1.json').and_return(response)
+      result = @instance.find(1)
+      result.should be_an_instance_of(Restful)
+      result.id.should == 42
+    end
+
+    it "performs a find to fetch one record in raw mode" do
+      response = { "restful" => { "id" => 42 }}
+      @instance.should_receive(:get).with('/restfuls/1.json').and_return(response)
+      result = @instance.raw.find(1)
+      result.should == response
+    end
+
+    it "performs a find to fetch one record with a prefix if provided" do
+      @instance  = ApiClient::Resource::Scope.new(Restful3)
+      response = { "restful3" => { "id" => 42 }}
+      @instance.should_receive(:get).with('/v1/restful3s/1.json').and_return(response)
+      result = @instance.find(1)
+      result.should be_an_instance_of(Restful3)
+      result.id.should == 42
+    end
+
+    it "performs a find_all to fetch many records" do
+      response = [{ "restful" => { "id" => 42 } }, { "restful" => { "id" => 112 } }]
+      @instance.should_receive(:get).with('/restfuls.json', {}).and_return(response)
+      result = @instance.find_all
+
+      result.should be_an_instance_of(Array)
+      result.first.should be_an_instance_of(Restful)
+      result.first.id.should == 42
+      result.last.should be_an_instance_of(Restful)
+      result.last.id.should == 112
+    end
+
+    it "performs a find_all to fetch many records in raw mode" do
+      response = [{ "restful" => { "id" => 42 } }, { "restful" => { "id" => 112 } }]
+      @instance.should_receive(:get).with('/restfuls.json', {}).and_return(response)
+      result = @instance.raw.find_all
+      result.should == response
+    end
+
+    it "performs a create to create a new record" do
+      response = { "restful" => { "id" => 42, "name" => "Foo" }}
+      @instance.should_receive(:post).with('/restfuls.json', {"restful" => {:name => "Foo"} }).and_return(response)
+      result = @instance.create(:name => "Foo")
+      result.should be_an_instance_of(Restful)
+      result.id.should == 42
+    end
+
+    it "performs a create to create a new record in raw mode" do
+      response = { "restful" => { "id" => 42, "name" => "Foo" }}
+      @instance.should_receive(:post).with('/restfuls.json', {"restful" => {:name => "Foo"} }).and_return(response)
+      result = @instance.raw.create(:name => "Foo")
+      result.should == response
+    end
+
+    it "performs a create to create a new record skipping the namespace if it is not present" do
+      @instance  = ApiClient::Resource::Scope.new(Restful2)
+      response = { "id" => 42, "name" => "Foo" }
+      @instance.should_receive(:post).with('/restful2s.json', {:name => "Foo"} ).and_return(response)
+      result = @instance.create(:name => "Foo")
+      result.should be_an_instance_of(Restful2)
+      result.id.should == 42
+    end
+
+    it "performs a update to update an existing record" do
+      response = { "restful" => { "id" => 42, "name" => "Foo" }}
+      @instance.should_receive(:put).with('/restfuls/42.json', {"restful" => {:name => "Foo"} }).and_return(response)
+      result = @instance.update(42, :name => "Foo")
+      result.should be_an_instance_of(Restful)
+      result.id.should == 42
+    end
+
+    it "performs a update to update an existing record in raw mode" do
+      response = { "restful" => { "id" => 42, "name" => "Foo" }}
+      @instance.should_receive(:put).with('/restfuls/42.json', {"restful" => {:name => "Foo"} }).and_return(response)
+      result = @instance.raw.update(42, :name => "Foo")
+      result.should == response
+    end
+
+    it "performs a update to update an existing record skipping the namespace if it is not present" do
+      @instance = ApiClient::Resource::Scope.new(Restful2)
+      response = { "id" => 42, "name" => "Foo" }
+      @instance.should_receive(:put).with('/restful2s/42.json', {:name => "Foo"} ).and_return(response)
+      result = @instance.update(42, :name => "Foo")
+      result.should be_an_instance_of(Restful2)
+      result.id.should == 42
+    end
+
+    it "performs a destroy to remove a record" do
+      response = { "restful" => { "id" => 42, "name" => "Foo" }}
+      @instance.should_receive(:delete).with('/restfuls/42.json').and_return(response)
+      result = @instance.destroy(42)
+      result.should == true
+    end
+
+  end
+
+end