restful_resource 0.8.34 → 0.9.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 836be6dd290b1071856a1183d22e96781da2fe44
-  data.tar.gz: 1216e850bac0d6ee7ff4d9f7200470dd60e7d1fe
+  metadata.gz: 060b67be52d4bbec24a0eeb0c8a5732f76698925
+  data.tar.gz: b016396bcb6958c1538cab53e60698090bb9af2f
 SHA512:
-  metadata.gz: ec4e7af3158c8c541951a38a35db1a2884511fc406a7ada61f554619fa8436aa0f13aff63f8ed9d605b298c9022847a2748f5270d92a1cf666c40364cd7acf9d
-  data.tar.gz: a79bea7b469845c748c808c3fee801a120a9b11c6089081204970c365a8cd62cf9ccfe602d005cf51aef81a05f48fd75bcafbbc6b4f8bf243ab723667ff633ae
+  metadata.gz: 05be9cb4721f526c9f38a7505b5af2c32aa8b0de9a8c769a252115e12654afed340cd24deff2e17fabae0e5d9cf2abea4729225395f2f9e9f1d474c2beb40088
+  data.tar.gz: 72bab68f1a2d40dd9221351e983ef2dfbc99f765dc803073a22322819b9626c1633fd6b78b2f334d5e0d60a21f31811cd7366fb3706eceef90561ee115a5194a

data/.gitignore

@@ -15,3 +15,4 @@ spec/reports
 test/tmp
 test/version_tmp
 tmp
+.idea

data/Gemfile

@@ -1,5 +1,5 @@
 source 'https://rubygems.org'
 
-ruby '2.2.3'
+ruby '2.3.0'
 
 gemspec

data/lib/restful_resource/base.rb

@@ -2,18 +2,18 @@ module RestfulResource
   class Base < OpenObject
     extend RestfulResource::Associations
 
-    def self.configure(base_url: nil, username: nil, password: nil, logger: NullLogger.new)
-      @base_url = URI.parse(base_url)
-
-      RestClient.log = logger
-
-      auth = nil
+    def self.configure(base_url: nil, 
+                       username: nil, 
+                       password: nil, 
+                       logger: nil, 
+                       cache_store: nil)
 
-      if (username.present? && password.present?)
-        auth = RestfulResource::Authorization.http_authorization(username, password)
-      end
+      @base_url = URI.parse(base_url)
 
-      @http = RestfulResource::HttpClient.new(authorization: auth)
+      @http = RestfulResource::HttpClient.new(username: username, 
+                                              password: password, 
+                                              logger: logger, 
+                                              cache_store: cache_store)
     end
 
     def self.resource_path(url)

data/lib/restful_resource/http_client.rb

@@ -1,43 +1,89 @@
 module RestfulResource
   class HttpClient
-    class UnprocessableEntity < RuntimeError
+    class UnprocessableEntity < StandardError
       attr_reader :response
 
       def initialize(response)
-        @response = Response.new(body: response.body, headers: response.headers, status: response.code)
+        @response = Response.new(body: response[:body], headers: response[:headers], status: response[:status])
       end
     end
 
-    def initialize(authorization: nil)
-      @authorization = authorization
+    class ResourceNotFound < StandardError
+      def message
+        "404 Resource Not Found"
+      end
+    end
+
+    class OtherHttpError < StandardError
+      attr_reader :response
+
+      def initialize(response)
+        puts response
+        @response = Response.new(body: response[:body], headers: response[:headers], status: response[:status])
+      end
+
+      def message
+        "Http Error - Status code: #{response.status}"
+      end
+    end
+
+    def initialize(username: nil, password: nil, logger: nil, cache_store: nil)
+      @client = Faraday.new do |b|
+        b.request :url_encoded
+        b.response :raise_error
+
+        if logger
+          b.response :logger, logger
+        end
+
+        if cache_store
+          b.user :http_cache, store: cache_store
+        end
+
+        if username.present? && password.present?
+          b.basic_auth username, password
+        end
+
+        b.adapter :net_http
+      end
     end
 
     def get(url)
-      response = RestClient.get(url, :accept => :json, authorization: @authorization)
-      Response.new(body: response.body, headers: response.headers, status: response.code)
+      http_request(method: :get, url: url)
     end
 
     def delete(url)
-      response = RestClient.delete(url, :accept => :json, authorization: @authorization)
-      Response.new(body: response.body, headers: response.headers, status: response.code)
+      http_request(method: :delete, url: url)
     end
 
     def put(url, data: {})
-      begin
-        response = RestClient.put(url, data, :accept => :json, authorization: @authorization)
-      rescue RestClient::UnprocessableEntity => e
-        raise HttpClient::UnprocessableEntity.new(e.response)
-      end
-      Response.new(body: response.body, headers: response.headers, status: response.code)
+      http_request(method: :put, url: url, data: data)
     end
 
     def post(url, data: {})
-      begin
-        response = RestClient.post(url, data, :accept => :json, authorization: @authorization)
-      rescue RestClient::UnprocessableEntity => e
-        raise HttpClient::UnprocessableEntity.new(e.response)
+      http_request(method: :post, url: url, data: data)
+    end
+
+    private
+    def http_request(method: , url: , data: nil, accept: 'application/json')
+      response = @client.send(method) do |req|
+        req.body = data unless data.nil?
+        req.url url
+
+        if accept
+          req.headers['Accept'] = accept
+        end
+      end
+      Response.new(body: response.body, headers: response.headers, status: response.status)
+    rescue Faraday::Error::ResourceNotFound
+      raise HttpClient::ResourceNotFound
+    rescue Faraday::Error::ClientError => e
+      response = e.response
+      if response[:status] == 422
+        raise HttpClient::UnprocessableEntity.new(response)
+      else
+        raise HttpClient::OtherHttpError.new(response)
       end
-      Response.new(body: response.body, headers: response.headers, status: response.code)
     end
   end
 end

data/lib/restful_resource/version.rb

@@ -1,3 +1,3 @@
 module RestfulResource
-  VERSION = "0.8.34"
+  VERSION = '0.9.0'
 end

data/lib/restful_resource.rb

@@ -1,19 +1,19 @@
 require 'rack'
 require 'uri'
 require 'link_header'
-require 'restclient'
+require 'faraday'
 require 'active_support'
 require 'active_support/all'
-require_relative "restful_resource/version"
+require 'resolv-replace.rb'
+require_relative 'restful_resource/version'
 require_relative 'restful_resource/null_logger'
-require_relative "restful_resource/paginated_array"
-require_relative "restful_resource/parameter_missing_error"
-require_relative "restful_resource/resource_id_missing_error"
-require_relative "restful_resource/open_object"
+require_relative 'restful_resource/paginated_array'
+require_relative 'restful_resource/parameter_missing_error'
+require_relative 'restful_resource/resource_id_missing_error'
+require_relative 'restful_resource/open_object'
 require_relative 'restful_resource/response'
-require_relative 'restful_resource/authorization'
 require_relative 'restful_resource/http_client'
-require_relative "restful_resource/associations"
+require_relative 'restful_resource/associations'
 require_relative 'restful_resource/rails_validations'
-require_relative "restful_resource/base"
-require_relative "restful_resource/old_base"
+require_relative 'restful_resource/base'
+

data/restful_resource.gemspec

@@ -22,7 +22,8 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "rake"
   spec.add_development_dependency "rspec", "~> 3.1"
 
-  spec.add_dependency "rest-client"
+  spec.add_dependency "faraday"
+  spec.add_dependency "faraday-http-cache"
   spec.add_dependency "link_header"
   spec.add_dependency "activesupport"
   spec.add_dependency "rack"

data/spec/restful_resource/base_authorization_spec.rb

@@ -28,22 +28,6 @@ describe RestfulResource::Base, 'authorization' do
     expect(FirstTest.send(:http)).not_to equal(SecondTest.send(:http))
   end
 
-  it 'should have http auth on SecondClient when initialised first' do
-    SecondTest.send(:http)
-    FirstTest.send(:http)
-
-    authorization = SecondTest.send(:http).instance_variable_get :@authorization
-    expect(authorization).to be_truthy
-  end
-
-  it 'should have http auth on SecondTest when initialised second' do
-    FirstTest.send(:http)
-    SecondTest.send(:http)
-
-    authorization = SecondTest.send(:http).instance_variable_get :@authorization
-    expect(authorization).to be_truthy
-  end
-
   it 'should have same http auth on superclass' do
     expect(SecondTest.send(:http)).to equal(SecondClient.send(:http))
   end

data/spec/restful_resource/base_spec.rb

@@ -223,34 +223,6 @@ describe RestfulResource::Base do
     end
   end
 
-  describe 'logger' do
-    before do
-      RestfulResource::Base.configure(base_url: 'http://api.carwow.co.uk/')
-    end
-
-    context 'when no logger is passed' do
-      it 'defaults to NullLogger' do
-        expect(RestClient.log).to be_instance_of(RestfulResource::NullLogger)
-      end
-    end
-
-    context 'when a logger is passed' do
-      before do
-        RestfulResource::Base.configure(base_url: 'http://api.carwow.co.uk/', logger: my_logger)
-      end
-
-      after do
-        RestClient.log = RestfulResource::NullLogger.new
-      end
-
-      let(:my_logger) { double('logger') }
-
-      it 'uses that logger' do
-        expect(RestClient.log).to eq(my_logger)
-      end
-    end
-  end
-
   def response_with_page_information
     RestfulResource::Response.new(body: [{ id: 1, name: 'Golf'}, { id: 2, name: 'Polo' }].to_json,
                                  headers: { links: '<http://api.carwow.co.uk/makes/Volkswagen/models.json?page=6>;rel="last",<http://api.carwow.co.uk/makes/Volkswagen/models.json?page=2>;rel="next"'})

data/spec/restful_resource/http_client_spec.rb

@@ -34,12 +34,18 @@ describe RestfulResource::HttpClient do
     it 'post should raise error 422' do
       expect { @http_client.post('http://httpbin.org/status/422', data: { name: 'Mad cow' }) }.to raise_error(RestfulResource::HttpClient::UnprocessableEntity)
     end
+
+    it 'should raise error on 404' do
+      expect { @http_client.get('http://httpbin.org/status/404') }.to raise_error(RestfulResource::HttpClient::ResourceNotFound)
+      expect { @http_client.delete('http://httpbin.org/status/404') }.to raise_error(RestfulResource::HttpClient::ResourceNotFound)
+      expect { @http_client.put('http://httpbin.org/status/404', data: { name: 'Mad cow' }) }.to raise_error(RestfulResource::HttpClient::ResourceNotFound)
+      expect { @http_client.post('http://httpbin.org/status/404', data: { name: 'Mad cow' }) }.to raise_error(RestfulResource::HttpClient::ResourceNotFound)
+    end
   end
 
   describe 'Authentication' do
     before :each do
-      auth = RestfulResource::Authorization.http_authorization('user', 'passwd')
-      @http_client = RestfulResource::HttpClient.new(authorization: auth)
+      @http_client = RestfulResource::HttpClient.new(username: 'user', password: 'passwd')
     end
 
     it 'should execute authenticated get' do

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: restful_resource
 version: !ruby/object:Gem::Version
-  version: 0.8.34
+  version: 0.9.0
 platform: ruby
 authors:
 - David Santoro
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-11-09 00:00:00.000000000 Z
+date: 2016-01-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -54,7 +54,21 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '3.1'
 - !ruby/object:Gem::Dependency
-  name: rest-client
+  name: faraday
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: faraday-http-cache
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -128,7 +142,6 @@ files:
 - lib/restful_resource/base.rb
 - lib/restful_resource/http_client.rb
 - lib/restful_resource/null_logger.rb
-- lib/restful_resource/old_base.rb
 - lib/restful_resource/open_object.rb
 - lib/restful_resource/paginated_array.rb
 - lib/restful_resource/parameter_missing_error.rb
@@ -142,10 +155,8 @@ files:
 - spec/restful_resource/base_authorization_spec.rb
 - spec/restful_resource/base_spec.rb
 - spec/restful_resource/http_client_spec.rb
-- spec/restful_resource/old_base_spec.rb
 - spec/restful_resource/open_object_spec.rb
 - spec/restful_resource/rails_validations_spec.rb
-- spec/restful_resource/rest_client_spec.rb
 - spec/spec_helper.rb
 homepage: http://www.github.com/carwow/restful_resource
 licenses:
@@ -167,7 +178,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.5.1
+rubygems_version: 2.5.1
 signing_key: 
 specification_version: 4
 summary: A simple activerecord inspired rest resource base class implemented using
@@ -178,8 +189,6 @@ test_files:
 - spec/restful_resource/base_authorization_spec.rb
 - spec/restful_resource/base_spec.rb
 - spec/restful_resource/http_client_spec.rb
-- spec/restful_resource/old_base_spec.rb
 - spec/restful_resource/open_object_spec.rb
 - spec/restful_resource/rails_validations_spec.rb
-- spec/restful_resource/rest_client_spec.rb
 - spec/spec_helper.rb

data/lib/restful_resource/old_base.rb

@@ -1,172 +0,0 @@
-module RestfulResource
-  class OldBase
-    def self.url=(url)
-      @url = url
-    end
-
-    def self.processed_url_and_params(params={})
-      url = @url
-      other_params = params.clone
-      missing_params = []
-
-      url_params = url.scan(/:([A-Za-z][^\/]*)/).flatten
-      url_params.each do |key|
-        value = other_params.delete(key.to_sym)
-        if value.nil?
-          missing_params << key
-        else
-          url = url.gsub(':'+key.to_s, value.to_s)
-        end
-      end
-
-      if missing_params.any?
-        raise ParameterMissingError.new(missing_params)
-      end
-
-      [url, other_params]
-    end
-
-    def self.url(params={})
-      processed_url_and_params(params).first
-    end
-
-
-    def self.has_one(nested_resource_type)
-      klass = nested_resource_type.to_s.camelize.safe_constantize
-      klass = OpenStruct if (klass.nil? || klass.superclass != RestfulResource)
-
-      self.send(:define_method, nested_resource_type) do
-        nested_resource = @inner_object.send(nested_resource_type)
-        return nil if nested_resource.nil?
-        klass.new(@inner_object.send(nested_resource_type))
-      end
-    end
-
-    def self.has_many(nested_resource_type)
-      klass = nested_resource_type.to_s.singularize.camelize.safe_constantize
-      klass = OpenStruct if (klass.nil? || (klass.superclass != RestfulResource))
-
-      self.send(:define_method, nested_resource_type) do
-        @inner_object.send(nested_resource_type).map { |obj| klass.new(obj) }
-      end
-    end
-
-    def initialize(attributes = {}, hack_for_activeresource = false)
-      @inner_object = OpenStruct.new(attributes)
-    end
-
-    def method_missing(method)
-      if @inner_object.respond_to?(method)
-        @inner_object.send(method)
-      else
-        super(method)
-      end
-    end
-
-    def respond_to?(method, include_private = false)
-      super || @inner_object.respond_to?(method, include_private)
-    end
-
-    def valid?
-      errors.nil? || errors.count == 0
-    end
-
-    def self.find(id, url_params={})
-      response = RestClient.get("#{url(url_params)}/#{id}", params: {})
-      self.new(ActiveSupport::JSON.decode(response))
-    end
-
-    def self.get_one(url_params={})
-      resource = create_new_resource(url_params)
-      response = resource.get
-      self.new(ActiveSupport::JSON.decode(response))
-    end
-
-    def self.update_attributes(id, attributes)
-      begin
-        result = parse(RestClient.put("#{url}/#{id}", attributes))
-      rescue RestClient::UnprocessableEntity => e
-        errors = parse(e.response)
-        result = attributes.merge(errors: errors)
-      end
-      self.new(result)
-    end
-
-    def self.create(attributes)
-      begin
-        result = parse(RestClient.post("#{url}", attributes))
-      rescue RestClient::UnprocessableEntity => e
-        errors = parse(e.response)
-        result = attributes.merge(errors: errors)
-      end
-      self.new(result)
-    end
-
-    def self.search(params = {})
-      response = RestClient.get("#{url}/search", params: params)
-      paginate_response(response)
-    end
-
-    def self.all(params = {})
-      resource = create_new_resource(params)
-      response = resource.get
-      paginate_response(response)
-    end
-
-    def self.get(postfix_url = "", params = {})
-      response = RestClient.get("#{url}#{postfix_url}", params: params)
-      paginate_response(response)
-    end
-
-    def self.put(postfix_url = "", params = {})
-      response = RestClient.put("#{url}#{postfix_url}", params)
-    end
-
-    def self.post(postfix_url = "", params = {})
-      response = RestClient.post("#{url}#{postfix_url}", params)
-    end
-
-    def self.all_not_paginated
-      page = 1
-      results = []
-      while page
-        page_data = self.all(page: page);
-        results += page_data
-        page = page_data.next_page
-      end
-
-      results
-    end
-
-    def self.parse(json)
-      ActiveSupport::JSON.decode(json)
-    end
-
-    def to_json(*args)
-      @inner_object.send(:table).to_json(*args)
-    end
-
-    def as_json(*)
-      @inner_object.send(:table).as_json
-    end
-
-    private
-    def self.paginate_response(response)
-      links_header =  response.headers[:links]
-      links = LinkHeader.parse(links_header)
-
-      prev_url = links.find_link(['rel', 'prev']).try(:href)
-      next_url = links.find_link(['rel', 'next']).try(:href)
-
-      array = ActiveSupport::JSON.decode(response).map { |attributes| self.new(attributes) }
-      PaginatedArray.new(array, previous_page_url: prev_url, next_page_url: next_url, total_count: response.headers['X-Total-Count'])
-    end
-
-    def self.create_new_resource(params={})
-      url, other_params = processed_url_and_params(params)
-      url += "?#{other_params.to_query}" if not other_params.empty?
-      resource = RestClient::Resource.new("#{url}")
-    end
-
-  end
-end

data/spec/restful_resource/old_base_spec.rb

@@ -1,119 +0,0 @@
-require_relative '../spec_helper'
-
-describe RestfulResource::OldBase do
-  context "#find" do
-    it "should retrieve a resource with a simple url" do
-      response = { id: 15, name: 'Arsenal' }.to_json
-      stub_get('http://api.carwow.co.uk/teams/15', response)
-
-      team = Team.find(15)
-
-      expect(team.id).to eq 15
-      expect(team.name).to eq 'Arsenal'
-    end
-
-    it "should retrieve a nested resource" do
-      response = { id: 1, team_id: 15, name: 'David', santoro: 'Santoro' }.to_json
-      stub_get('http://api.carwow.co.uk/teams/15/players/1', response)
-
-      player = Player.find(1, team_id: 15)
-
-      expect(player.id).to eq 1
-      expect(player.team_id).to eq 15
-      expect(player.name).to eq 'David'
-    end
-  end
-
-  context "#url" do
-    it "should return the url set if no extra parameters are necessary" do
-      Player.url = 'http://api.carwow.co.uk/players'
-
-      expect(Player.url).to eq 'http://api.carwow.co.uk/players'
-    end
-
-    it "should return the url with the right parameters replaced" do
-      Player.url = 'http://api.carwow.co.uk/teams/:team_id/players'
-
-      expect(Player.url(team_id: 13)).to eq 'http://api.carwow.co.uk/teams/13/players'
-    end
-
-    it "should raise a parameter required exception if parameter needed and not provided" do
-      Player.url = 'http://api.carwow.co.uk/countries/:country_slug/teams/:team_id/players'
-
-      expected_error_message = 'You must pass values for the following parameters: [country_slug, team_id]'
-      expect { Player.url }.to raise_error(RestfulResource::ParameterMissingError, expected_error_message)
-    end
-
-    it "should not confuse port number as a parameter" do
-      Player.url = 'http://api.carwow.co.uk:7000/teams/:team_id/players'
-
-      expect { Player.url(team_id: 13) }.not_to raise_error
-    end
-  end
-
-  context "#all" do
-    it "should provide a paginated result if response contains rest pagination headers" do
-      response = response_with_page_information()
-      stub_new_resource('http://api.carwow.co.uk/teams', response)
-
-      teams = Team.all
-
-      expect(teams.previous_page).to be_nil
-      expect(teams.next_page).to eq 2
-      expect(teams.first.name).to eq 'Arsenal'
-      expect(teams.last.name).to eq 'Chelsea'
-    end
-  end
-
-  it "should act as an openstruct" do
-    example = Player.new(name: 'David', surname: 'Santoro')
-
-    expect(example.name).to eq 'David'
-    expect(example.surname).to eq 'Santoro'
-  end
-
-  it "should use some params for the url and other for the query string" do
-    stub_new_resource('http://api.carwow.co.uk/teams/15/players?name_like=Ars', response_with_page_information)
-
-    players = Player.all(team_id: 15, name_like: 'Ars')
-  end
-
-  it "should raise an error when accessing a field that doesn't exist" do
-    player = Player.new({name: 'David', surname: 'Santoro'})
-
-    expect { player.age }.to raise_error(NoMethodError)
-  end
-
-  private
-  def stub_new_resource(url, fake_response)
-    resource = instance_double('RestClient::Resource', get: fake_response)
-    allow(RestClient::Resource).to receive(:new).with(url).and_return resource
-  end
-
-  def stub_get(url, fake_response, params = {})
-    expect(RestClient).to receive(:get).
-                          with(url, params: params).
-                          and_return(fake_response)
-  end
-
-  def response_with_page_information
-    response = [{ id: 1, name: 'Arsenal'}, { id: 2, name: 'Chelsea' }].to_json
-    allow(response).to receive(:headers) {
-      {:links => '<http://api.carwow.co.uk/teams.json?page=6>;rel="last",<http://api.carwow.co.uk/teams.json?page=2>;rel="next"'}
-    }
-    response
-  end
-end
-
-class Team < RestfulResource::OldBase
-  self.url = "http://api.carwow.co.uk/teams"
-end
-
-class Player < RestfulResource::OldBase
-  has_one :team
-
-  self.url = "http://api.carwow.co.uk/teams/:team_id/players"
-end
-
-
-

data/spec/restful_resource/rest_client_spec.rb

@@ -1,15 +0,0 @@
-require_relative '../spec_helper'
-
-describe RestfulResource::Base do
-  context "#get" do
-    it "should throw an exception with wrong url" do
-      expect{RestClient.get("http://www.example.com/djksafjadl", params: {})}.to raise_error
-    end
-
-    it "should throw an exception with wrong url" do
-      r = RestClient::Resource.new("http://www.example.com/djksafjadl")
-      expect{r.get}.to raise_error
-    end
-  end
-
-end