ddy_remote_resource 0.4.11 → 1.0.0.rc1

data/lib/remote_resource/response.rb

@@ -26,6 +26,10 @@ module RemoteResource
       original_response.response_code
     end
 
+    def response_headers
+      original_response.headers
+    end
+
     def sanitized_response_body
       return empty_hash if response_body.blank?
       return empty_hash if parsed_response_body.blank?
@@ -75,4 +79,4 @@ module RemoteResource
     end
 
   end
-end
+end

data/lib/remote_resource/rest.rb

@@ -1,28 +1,24 @@
 module RemoteResource
   module REST
-    extend ActiveSupport::Concern
 
-    ACTIONS = [:get, :put, :patch, :post, :delete]
-
-    module ClassMethods
+    def get(attributes = {}, connection_options = {})
+      RemoteResource::Request.new(self, __method__, attributes, connection_options).perform
+    end
 
-      RemoteResource::REST::ACTIONS.each do |action|
-        define_method action do |*args|
-          attributes         = args[0] || {}
-          connection_options = args[1] || {}
+    def put(attributes = {}, connection_options = {})
+      RemoteResource::Request.new(self, __method__, attributes, connection_options).perform
+    end
 
-          RemoteResource::Request.new(self, action, attributes, connection_options).perform
-        end
-      end
+    def patch(attributes = {}, connection_options = {})
+      RemoteResource::Request.new(self, __method__, attributes, connection_options).perform
     end
 
-    RemoteResource::REST::ACTIONS.each do |action|
-      define_method action do |*args|
-        attributes         = args[0] || {}
-        connection_options = args[1] || {}
+    def post(attributes = {}, connection_options = {})
+      RemoteResource::Request.new(self, __method__, attributes, connection_options).perform
+    end
 
-        RemoteResource::Request.new(self, action, attributes, connection_options).perform
-      end
+    def delete(attributes = {}, connection_options = {})
+      RemoteResource::Request.new(self, __method__, attributes, connection_options).perform
     end
 
   end

data/lib/remote_resource/url_naming.rb

@@ -10,25 +10,19 @@ module RemoteResource
 
     module ClassMethods
 
-      def app_host(app, env = 'development')
-        CONFIG[env.to_sym][:apps][app.to_sym]
+      def app_host(*_)
+        warn '[DEPRECATION] `.app_host` is deprecated. Please use a different method to determine the site.'
       end
 
       def base_url
-        determined_url_naming.base_url
+        warn '[DEPRECATION] `.base_url` is deprecated. Please use the connection_options[:base_url] when querying instead.'
       end
 
       def use_relative_model_naming?
         true
       end
 
-      private
-
-      def determined_url_naming
-        RemoteResource::UrlNamingDetermination.new self
-      end
-
     end
 
   end
-end
+end

data/lib/remote_resource/url_naming_determination.rb

@@ -14,9 +14,7 @@ module RemoteResource
       path_prefix  = connection_options.fetch(:path_prefix, resource_klass.path_prefix)
       path_postfix = connection_options.fetch(:path_postfix, resource_klass.path_postfix)
 
-      id           = "/#{id}" if id.present?
-
-      "#{site}#{version.presence}#{path_prefix.presence}#{collection_prefix(check_collection_options)}/#{url_safe_relative_name}#{id}#{path_postfix.presence}"
+      File.join(site.to_s, version.to_s, path_prefix.to_s, collection_prefix(check_collection_options).to_s, url_safe_relative_name, id.to_s, path_postfix.to_s).chomp('/')
     end
 
     def collection_prefix(check_collection_options)

data/lib/remote_resource/util.rb

@@ -0,0 +1,64 @@
+module RemoteResource
+  module Util
+
+    FILTERED = '[FILTERED]'.freeze
+
+    def self.filter_params(query_string_or_json_body, filtered_params:)
+      filtered = query_string_or_json_body
+      filtered_params.each do |filtered_param|
+        filtered = filtered.to_s.gsub(/(?<="#{filtered_param}":|#{filtered_param}=)(.*?)(?=,|}|&|$)/, FILTERED)
+      end
+      filtered
+    end
+
+    def self.encode_params_to_query(params)
+      if params.is_a?(String)
+        pairs = [params]
+      else
+        pairs = recursively_generate_query(params, nil)
+      end
+
+      URI.encode_www_form(pairs)
+    end
+
+    # This method is based on the monkey patched method:
+    # Ethon::Easy::Queryable#recursively_generate_pairs
+    #
+    # The monkey patch was needed to pass Array
+    # params without an index.
+    #
+    # The problem is described in typhoeus/typhoeus issue #320:
+    # https://github.com/typhoeus/typhoeus/issues/320
+    #
+    # The fix is described in dylanfareed/ethon commit 548033a:
+    # https://github.com/dylanfareed/ethon/commit/548033a8557a48203b7d49f3f98812bd79bc05e4
+    #
+    def self.recursively_generate_query(component, prefix, pairs = [])
+      case component
+      when Hash
+        component.each do |key, value|
+          key = prefix.nil? ? key : "#{prefix}[#{key}]"
+
+          if value.respond_to?(:each)
+            recursively_generate_query(value, key, pairs)
+          else
+            pairs.push([key, value.to_s])
+          end
+        end
+      when Array
+        component.each do |value|
+          key = "#{prefix}[]"
+
+          if value.respond_to?(:each)
+            recursively_generate_query(value, key, pairs)
+          else
+            pairs.push([key, value.to_s])
+          end
+        end
+      end
+
+      pairs
+    end
+
+  end
+end

data/lib/remote_resource/version.rb

@@ -1,3 +1,3 @@
 module RemoteResource
-  VERSION = '0.4.11'
+  VERSION = '1.0.0.rc1'.freeze
 end

data/remote_resource.gemspec

@@ -22,10 +22,10 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency 'rake', '~> 10.4'
   spec.add_development_dependency 'rspec', '~> 3.1'
   spec.add_development_dependency 'pry', '~> 0.10'
-  spec.add_development_dependency 'webmock', '~> 1.24'
+  # spec.add_development_dependency 'webmock', '~> 1.24'
   spec.add_development_dependency 'guard', '~> 2.14'
   spec.add_development_dependency 'guard-rspec', '~> 4.7'
-  spec.add_development_dependency 'terminal-notifier-guard', '~> 1.6.1'
+  spec.add_development_dependency 'terminal-notifier-guard', '~> 1.6'
 
   spec.add_runtime_dependency 'activesupport', '~> 4.1'
   spec.add_runtime_dependency 'activemodel', '~> 4.1'

data/spec/fixtures/text_file.txt

@@ -0,0 +1 @@
+Hello world!

data/spec/integration/all_spec.rb

@@ -0,0 +1,166 @@
+require 'spec_helper'
+
+RSpec.describe '.all' do
+
+  class Post
+    include RemoteResource::Base
+
+    self.site         = 'https://www.example.com'
+    self.collection   = true
+    self.root_element = :data
+
+    attribute :title, String
+    attribute :body, String
+    attribute :created_at, Time
+  end
+
+  let(:response_body) do
+    {
+      data: [
+              {
+                id:         12,
+                title:      'Lorem Ipsum',
+                body:       'Lorem ipsum dolor sit amet, consectetur adipiscing elit.',
+                created_at: Time.new(2015, 10, 4, 9, 30, 0),
+              },
+              {
+                id:         14,
+                title:      'Mauris Purus',
+                body:       'Mauris purus urna, ultrices et suscipit ut, faucibus eget mauris.',
+                created_at: Time.new(2015, 12, 11, 11, 32, 0),
+              },
+              {
+                id:         16,
+                title:      'Vestibulum Commodo',
+                body:       'Vestibulum commodo fringilla suscipit.',
+                created_at: Time.new(2016, 2, 6, 18, 45, 0),
+              },
+            ]
+    }
+  end
+
+  let(:expected_default_headers) do
+    { 'Accept' => 'application/json', 'User-Agent' => "RemoteResource #{RemoteResource::VERSION}" }
+  end
+
+  describe 'default behaviour' do
+    let!(:expected_request) do
+      mock_request = stub_request(:get, 'https://www.example.com/posts.json')
+      mock_request.with(query: nil, body: nil, headers: expected_default_headers)
+      mock_request.to_return(status: 200, body: response_body.to_json)
+      mock_request
+    end
+
+    it 'performs the correct HTTP GET request' do
+      Post.all
+      expect(expected_request).to have_been_requested
+    end
+
+    it 'builds the correct collection of resources' do
+      posts = Post.all
+
+      aggregate_failures do
+        expect(posts).to respond_to :each
+        expect(posts).to all(be_a(Post))
+        expect(posts.size).to eql 3
+
+        expect(posts[0].id).to eql 12
+        expect(posts[0].title).to eql 'Lorem Ipsum'
+        expect(posts[0].body).to eql 'Lorem ipsum dolor sit amet, consectetur adipiscing elit.'
+        expect(posts[0].created_at).to eql Time.new(2015, 10, 4, 9, 30, 0)
+        expect(posts[1].id).to eql 14
+        expect(posts[1].title).to eql 'Mauris Purus'
+        expect(posts[1].body).to eql 'Mauris purus urna, ultrices et suscipit ut, faucibus eget mauris.'
+        expect(posts[1].created_at).to eql Time.new(2015, 12, 11, 11, 32, 0)
+        expect(posts[2].id).to eql 16
+        expect(posts[2].title).to eql 'Vestibulum Commodo'
+        expect(posts[2].body).to eql 'Vestibulum commodo fringilla suscipit.'
+        expect(posts[2].created_at).to eql Time.new(2016, 2, 6, 18, 45, 0)
+      end
+    end
+  end
+
+  describe 'with connection_options[:params]' do
+    let!(:expected_request) do
+      mock_request = stub_request(:get, 'https://www.example.com/posts.json')
+      mock_request.with(query: { pseudonym: 'pseudonym' }, body: nil, headers: expected_default_headers)
+      mock_request.to_return(status: 200, body: response_body.to_json)
+      mock_request
+    end
+
+    it 'performs the correct HTTP GET request' do
+      Post.all(params: { pseudonym: 'pseudonym' })
+      expect(expected_request).to have_been_requested
+    end
+  end
+
+  describe 'with connection_options[:headers]' do
+    let!(:expected_request) do
+      mock_request = stub_request(:get, 'https://www.example.com/posts.json')
+      mock_request.with(query: nil, body: nil, headers: expected_default_headers.merge({ 'X-Pseudonym' => 'pseudonym' }))
+      mock_request.to_return(status: 200, body: response_body.to_json)
+      mock_request
+    end
+
+    it 'performs the correct HTTP GET request' do
+      Post.all(headers: { 'X-Pseudonym' => 'pseudonym' })
+      expect(expected_request).to have_been_requested
+    end
+  end
+
+  describe 'with a 404 response' do
+    let!(:expected_request) do
+      mock_request = stub_request(:get, 'https://www.example.com/posts.json')
+      mock_request.with(query: { pseudonym: 'pseudonym' }, body: nil, headers: expected_default_headers.merge({ 'X-Pseudonym' => 'pseudonym' }))
+      mock_request.to_return(status: 404)
+      mock_request
+    end
+
+    it 'raises the not found error' do
+      expect { Post.all(params: { pseudonym: 'pseudonym' }, headers: { 'X-Pseudonym' => 'pseudonym' }) }.to raise_error RemoteResource::HTTPNotFound
+    end
+
+    it 'adds metadata to the raised error' do
+      begin
+        Post.all(params: { pseudonym: 'pseudonym' }, headers: { 'X-Pseudonym' => 'pseudonym' })
+      rescue RemoteResource::HTTPNotFound => error
+        aggregate_failures do
+          expect(error.message).to eql 'HTTP request failed for Post with response_code=404 with http_action=get with request_url=https://www.example.com/posts.json'
+          expect(error.request_url).to eql 'https://www.example.com/posts.json'
+          expect(error.response_code).to eql 404
+          expect(error.request_query).to eql(RemoteResource::Util.encode_params_to_query({ pseudonym: 'pseudonym' }))
+          expect(error.request_headers).to eql(expected_default_headers.merge({ 'X-Pseudonym' => 'pseudonym' }))
+        end
+      end
+    end
+  end
+
+  describe 'with a 500 response' do
+    let!(:expected_request) do
+      mock_request = stub_request(:get, 'https://www.example.com/posts.json')
+      mock_request.with(query: { pseudonym: 'pseudonym' }, body: nil, headers: expected_default_headers.merge({ 'X-Pseudonym' => 'pseudonym' }))
+      mock_request.to_return(status: 500)
+      mock_request
+    end
+
+    it 'raises the server error' do
+      expect { Post.all(params: { pseudonym: 'pseudonym' }, headers: { 'X-Pseudonym' => 'pseudonym' }) }.to raise_error RemoteResource::HTTPServerError
+    end
+
+    it 'adds metadata to the raised error' do
+      begin
+        Post.all(params: { pseudonym: 'pseudonym' }, headers: { 'X-Pseudonym' => 'pseudonym' })
+      rescue RemoteResource::HTTPServerError => error
+        aggregate_failures do
+          expect(error.message).to eql 'HTTP request failed for Post with response_code=500 with http_action=get with request_url=https://www.example.com/posts.json'
+          expect(error.request_url).to eql 'https://www.example.com/posts.json'
+          expect(error.response_code).to eql 500
+          expect(error.request_query).to eql(RemoteResource::Util.encode_params_to_query({ pseudonym: 'pseudonym' }))
+          expect(error.request_headers).to eql(expected_default_headers.merge({ 'X-Pseudonym' => 'pseudonym' }))
+        end
+      end
+    end
+  end
+
+
+end

data/spec/integration/collection_prefix_spec.rb

@@ -0,0 +1,99 @@
+require 'spec_helper'
+
+RSpec.describe 'connection_options[:collection_prefix] and connection_options[:collection_options]' do
+
+  class Post
+    include RemoteResource::Base
+
+    self.site         = 'https://www.example.com'
+    self.collection   = true
+    self.root_element = :data
+
+    attribute :title, String
+    attribute :body, String
+    attribute :featured, Boolean
+    attribute :created_at, Time
+  end
+
+  class Comment
+    include RemoteResource::Base
+
+    self.site              = 'https://www.example.com'
+    self.collection        = true
+    self.collection_prefix = '/posts/:post_id'
+    self.root_element      = :data
+
+    attribute :body, String
+    attribute :commented_at, Time
+  end
+
+  describe 'connection_options[:collection_prefix] defined on class' do
+    let(:response_body) do
+      {
+        data: {
+          id:           18,
+          body:         'Very interesting comment',
+          commented_at: Time.new(2016, 12, 8, 11, 38, 0)
+        }
+      }
+    end
+
+    let!(:expected_request) do
+      mock_request = stub_request(:get, 'https://www.example.com/posts/12/comments/18.json')
+      mock_request.to_return(status: 200, body: response_body.to_json)
+      mock_request
+    end
+
+    it 'performs the correct HTTP GET request' do
+      Comment.find(18, collection_options: { post_id: 12 })
+      expect(expected_request).to have_been_requested
+    end
+
+    it 'builds the correct resource' do
+      comment = Comment.find(18, collection_options: { post_id: 12 })
+
+      aggregate_failures do
+        expect(comment.id).to eql 18
+        expect(comment.body).to eql 'Very interesting comment'
+        expect(comment.commented_at).to eql Time.new(2016, 12, 8, 11, 38, 0)
+      end
+    end
+  end
+
+  describe 'connection_options[:collection_prefix] given as argument' do
+    let(:response_body) do
+      {
+        data: {
+          id:         12,
+          title:      'Lorem Ipsum',
+          body:       'Lorem ipsum dolor sit amet, consectetur adipiscing elit.',
+          featured:   true,
+          created_at: Time.new(2015, 10, 4, 9, 30, 0),
+        }
+      }
+    end
+
+    let!(:expected_request) do
+      mock_request = stub_request(:get, 'https://www.example.com/users/450/posts/12.json')
+      mock_request.to_return(status: 200, body: response_body.to_json)
+      mock_request
+    end
+
+    it 'performs the correct HTTP GET request' do
+      Post.find(12, collection_prefix: '/users/:user_id', collection_options: { user_id: 450 })
+      expect(expected_request).to have_been_requested
+    end
+
+    it 'builds the correct resource' do
+      post = Post.find(12, collection_prefix: '/users/:user_id', collection_options: { user_id: 450 })
+
+      aggregate_failures do
+        expect(post.id).to eql 12
+        expect(post.title).to eql 'Lorem Ipsum'
+        expect(post.body).to eql 'Lorem ipsum dolor sit amet, consectetur adipiscing elit.'
+        expect(post.created_at).to eql Time.new(2015, 10, 4, 9, 30, 0)
+      end
+    end
+  end
+
+end