ddy_remote_resource 0.4.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: eb2c03a904db96aa05327826f442deb7b2852228
+  data.tar.gz: 4cd7f8229e8a6c7d43d47bc1e4d45c1f3cdb832c
+SHA512:
+  metadata.gz: 7390456c69a1ca82d053f44e7966f6f160e0b361af64f4670e2000bb5fe5160feafb2499809be857538c8d1b8e03dc96db218da497c3f73be6e97e5401cec7f3
+  data.tar.gz: aa727cdb44ed2933313c2c3681f6fa7e400c66d607be48194c6ade900add787f6754e107885c1fc4a1549a1504641ffa787b12158593b7d634f4ff51418dc0fd

data/.gitignore

@@ -0,0 +1,22 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.ruby-gemset

@@ -0,0 +1 @@
+remote_resource

data/.ruby-version

@@ -0,0 +1 @@
+2.1.1

data/.travis.yml

@@ -0,0 +1,3 @@
+language: ruby
+rvm:
+  - 2.1.1

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in remote_resource.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Jan van der Pas
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,182 @@
+# RemoteResource
+
+RemoteResource is a gem to use resources with REST services.
+
+## Goal of RemoteResource
+
+To replace `ActiveResource` by providing a dynamic and customizable API interface for REST services.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'remote_resource', git: 'git@lab.digidentity.eu:jvanderpas/remote_resource.git'
+```
+
+
+## Usage
+
+Simply include the `RemoteResource::Base` module in the class you want to enable for the REST services.
+
+```ruby
+class ContactPerson
+  include RemoteResource::Base
+
+  self.site    = "https://www.myapp.com"
+  self.version = '/v2'
+end
+```
+
+### Options
+
+You can set a few options for the `RemoteResource` enabled class.
+
+
+#### Base URL options (`base_url`)
+
+The `base_url` is constructed from the `.site`, `.version`,  `.path_prefix`, `.path_postfix`, `.collection`, and `.collection_name` options. The `.collection_name` is automatically constructed from the relative class name.
+
+We will use the `ContactPerson` class for these examples, with the `.collection_name` of `'contact_person'`:
+
+* `.site`: This sets the URL which should be used to construct the `base_url`.
+    * *Example:* `.site = "https://www.myapp.com"`
+    * *`base_url`:* `https://www.myapp.com/contact_person`
+* `.version`: This sets the API version for the path, after the `.site` and before the `.path_prefix` that is used to construct the `base_url`.
+    * *Example:* `.version = "/api/v2"`
+    * *`base_url`:* `https://www.myapp.com/api/v2/contact_person`
+* `.path_prefix`: This sets the prefix for the path, after the `.version` and before the `.collection_name` that is used to construct the `base_url`.
+    * *Example:* `.path_prefix = "/registration"`
+    * *`base_url`:* `https://www.myapp.com/registration/contact_person`
+* `.path_postfix`: This sets the postfix for the path, after the `.collection_name` that is used to construct the `base_url`.
+    * *Example:* `.path_postfix = "/new"`
+    * *`base_url`:* `https://www.myapp.com/contact_person/new`
+* `.collection`: This toggles the pluralization of the `collection_name` that is used to construct the `base_url`.
+    * *Default:* `false`
+    * *Example:* `.collection = true`
+    * *`base_url`:* `https://www.myapp.com/contact_persons`
+* `.collection_name`: This sets the `collection_name` that is used to construct the `base_url`.
+    * *Example:* `.collection_name = "company"`
+    * *`base_url`:* `https://www.myapp.com/company`
+
+**override**
+
+To override the `base_url` completely, you can use the `base_url` option. This option should be passed into the `connection_options` hash when making a request:
+
+* `base_url`: This sets the `base_url`. *note: this does not override the `.content_type` option*
+    * *Example:* `{ base_url: "https://api.foo.com/v1" }`
+    * *`base_url`:* `https://api.foo.com/v1`
+
+
+#### Request options
+
+Apart from the options which manipulate the `base_url`, there are some more:
+
+* `.extra_headers`: This sets the extra headers which are merged with the `.default_headers` and should be used for the request. *note: you can't set the `.default_headers`*
+    * *Default:* `.default_headers`: `{ "Content-Type" => "application/json" }`
+    * *Example:* `.extra_headers = { "X-Locale" => "en" }`
+    * `.headers`: `{ "Content-Type" => "application/json", "X-Locale" => "en" }`
+* `.content_type`: This sets the content-type which should be used for the request URL. *note: this is appended to the `base_url`*
+    * *Default:* `".json"`
+    * *`base_url`:* `https://www.myapp.com/contact_person`
+    * *Example:* `.content-type = ".json"`
+    * *Request URL:* `https://www.myapp.com/contact_person.json`
+
+#### Body and params options
+
+Last but not least, you can pack the request body or params in a `root_element`:
+
+* `.root_element`: This sets the `root_element` in which the request body or params should be 'packed' for the request.
+    * *Params:* `{ email_address: "foo@bar.com", phone_number: "0031701234567" }`
+    * *Example:* `.root_element = :contact_person`
+    * *Packed params:* `{ "contact_person" => { email_address: "foo@bar.com", phone_number: "0031701234567" } }`
+
+
+### Querying
+
+#### Finder methods
+
+You can use the `.find`, `.find_by` and `.all` class methods:
+
+```ruby
+# use the `id` as argument
+ContactPerson.find(12)
+
+# use a conditions `Hash` as argument
+ContactPerson.find_by(username: 'foobar')
+
+# just the whole collection
+ContactPerson.all
+```
+
+To override the given `options`, you can pass in a `connection_options` hash:
+
+```ruby
+connection_options: { root_element: :contact_person, headers: { "X-Locale" => "nl" } }
+
+# use the `id` as argument
+ContactPerson.find(12, connection_options)
+
+# use a conditions `Hash` as argument
+ContactPerson.find_by((username: 'foobar'), connection_options)
+```
+
+#### Persistence methods
+
+You can use the `.create` class method and the `#save` instance method:
+
+
+```ruby
+# .create
+ContactPerson.create(username: 'aapmies', first_name: 'Mies')
+
+# #save
+contact_person = ContactPerson.new(id: 12)
+contact_person.username = 'aapmies'
+contact_person.save
+```
+To override the given `options`, you can pass in a `connection_options` hash:
+
+```ruby
+connection_options: { root_element: :contact_person, headers: { "X-Locale" => "nl" } }
+
+contact_person = ContactPerson.new(id: 12)
+contact_person.username = 'aapmies'
+contact_person.save(connection_options)
+```
+
+#### REST methods
+
+You can use the `.get`, `.put`, `.patch` and `.post` class methods  and the `
+#get`, `#put`, `#patch` and `#post` instance methods.
+
+
+#### With a `connection_options` block
+
+You can make your requests in a `connection_options` block. All the requests in the block will use the passed in `connection_options`.
+
+```ruby
+ContactPerson.with_connection_options(headers: { "X-Locale" => "en" }) do
+  ContactPerson.find_by(username: 'foobar')
+  ContactPerson.find_by(username: 'aapmies', (content-type: '.xml'))
+  ContactPerson.find_by((username: 'viking'), (headers: { "X-Locale" => "nl" }))
+end
+```
+
+This will result in two request which use the `{ headers: { "X-Locale" => "en" } }` as `connection_options`, one which will use the `{ headers: { "X-Locale" => "nl" } }` as `connection_options`. And one that will append `.xml` to the request URL.
+
+### Responses
+
+The response body of the request will be 'unpacked' from the `root_element` if necessary and parsed. The resulting `Hash` will be used to assign the attributes of the resource.
+
+However if you want to access the response of the request, you can use the `#_response` method. This returns a `RemoteResource::Response` object with the `#response_body` and `#response_code` methods.
+
+
+```ruby
+contact_person = ContactPerson.find_by((username: 'foobar'), connection_options)
+contact_person._response                 #=> RemoteResource::Response
+contact_person._response.response_code   #=> 200
+contact_person._response.response_body   #=> '{"username":"foobar", "name":"Foo", "surname":"Bar"}'
+```
+
+

data/Rakefile

@@ -0,0 +1,7 @@
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec
+

data/lib/extensions/ethon/easy/queryable.rb

@@ -0,0 +1,36 @@
+# This is a monkey patch 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
+#
+
+require 'ethon'
+
+module Ethon
+  class Easy
+    module Queryable
+
+      private
+
+      def recursively_generate_pairs(h, prefix, pairs)
+        case h
+        when Hash
+          h.each_pair do |k,v|
+            key = prefix.nil? ? k : "#{prefix}[#{k}]"
+            pairs_for(v, key, pairs)
+          end
+        when Array
+          h.each_with_index do |v, i|
+            key = "#{prefix}[]"
+            pairs_for(v, key, pairs)
+          end
+        end
+      end
+
+    end
+  end
+end

data/lib/remote_resource.rb

@@ -0,0 +1,64 @@
+require 'active_support/all'
+require 'active_model'
+require 'virtus'
+require 'typhoeus'
+
+require_relative 'extensions/ethon/easy/queryable'
+
+require 'remote_resource/version'
+require 'remote_resource/base'
+require 'remote_resource/collection'
+require 'remote_resource/url_naming_determination'
+require 'remote_resource/url_naming'
+require 'remote_resource/connection'
+require 'remote_resource/builder'
+require 'remote_resource/connection_options'
+require 'remote_resource/rest'
+require 'remote_resource/response'
+require 'remote_resource/querying/finder_methods'
+require 'remote_resource/querying/persistence_methods'
+require 'remote_resource/http_errors'
+require 'remote_resource/request'
+
+
+module RemoteResource
+  RemoteResourceError = Class.new StandardError
+
+  RESTActionUnknown = Class.new RemoteResourceError # REST action
+
+  class HTTPError < RemoteResourceError # HTTP errors
+
+    def initialize(response)
+      if response.try :response_code
+        super "with HTTP response status: #{response.response_code} and response: #{response}"
+      else
+        super "with HTTP response: #{response}"
+      end
+    end
+  end
+
+  HTTPRedirectionError = Class.new HTTPError # HTTP 3xx
+  HTTPClientError      = Class.new HTTPError # HTTP 4xx
+  HTTPServerError      = Class.new HTTPError # HTTP 5xx
+
+  HTTPBadRequest        = Class.new HTTPClientError # HTTP 400
+  HTTPUnauthorized      = Class.new HTTPClientError # HTTP 401
+  HTTPForbidden         = Class.new HTTPClientError # HTTP 403
+  HTTPNotFound          = Class.new HTTPClientError # HTTP 404
+  HTTPMethodNotAllowed  = Class.new HTTPClientError # HTTP 405
+  HTTPNotAcceptable     = Class.new HTTPClientError # HTTP 406
+  HTTPRequestTimeout    = Class.new HTTPClientError # HTTP 408
+  HTTPConflict          = Class.new HTTPClientError # HTTP 409
+  HTTPGone              = Class.new HTTPClientError # HTTP 410
+  HTTPTeapot            = Class.new HTTPClientError # HTTP 418
+
+  NginxClientError = Class.new HTTPClientError # HTTP errors used in Nginx
+
+  HTTPNoResponse            = Class.new NginxClientError # HTTP 444
+  HTTPRequestHeaderTooLarge = Class.new NginxClientError # HTTP 494
+  HTTPCertError             = Class.new NginxClientError # HTTP 495
+  HTTPNoCert                = Class.new NginxClientError # HTTP 496
+  HTTPToHTTPS               = Class.new NginxClientError # HTTP 497
+  HTTPClientClosedRequest   = Class.new NginxClientError # HTTP 499
+
+end

data/lib/remote_resource/base.rb

@@ -0,0 +1,126 @@
+module RemoteResource
+  module Base
+    extend ActiveSupport::Concern
+
+    OPTIONS = [:base_url, :site, :headers, :version, :path_prefix, :path_postfix, :content_type, :collection, :collection_name, :root_element]
+
+    included do
+      include Virtus.model
+      extend ActiveModel::Naming
+      extend ActiveModel::Translation
+      include ActiveModel::Conversion
+      include ActiveModel::Validations
+
+      include RemoteResource::Builder
+      include RemoteResource::UrlNaming
+      include RemoteResource::Connection
+      include RemoteResource::REST
+
+      include RemoteResource::Querying::FinderMethods
+      include RemoteResource::Querying::PersistenceMethods
+
+      attr_accessor :_response
+
+      attribute :id
+      class_attribute :root_element, instance_accessor: false
+    end
+
+    def self.global_headers=(headers)
+      Thread.current[:global_headers] = headers
+    end
+
+    def self.global_headers
+      Thread.current[:global_headers] ||= {}
+    end
+
+    module ClassMethods
+
+      def connection_options
+        Thread.current[connection_options_thread_name] ||= RemoteResource::ConnectionOptions.new(self)
+      end
+
+      def threaded_connection_options
+        Thread.current[threaded_connection_options_thread_name] ||= {}
+      end
+
+      def with_connection_options(connection_options = {})
+        begin
+          threaded_connection_options
+          Thread.current[threaded_connection_options_thread_name].merge! connection_options
+          yield
+        ensure
+          Thread.current[threaded_connection_options_thread_name] = nil
+        end
+      end
+
+      private
+
+      def threaded_connection_options_thread_name
+        "remote_resource.#{_module_name}.threaded_connection_options"
+      end
+
+      def connection_options_thread_name
+        "remote_resource.#{_module_name}.connection_options"
+      end
+
+      def _module_name
+        self.name.to_s.demodulize.underscore.downcase
+      end
+    end
+
+    def connection_options
+      @connection_options ||= RemoteResource::ConnectionOptions.new(self.class)
+    end
+
+    def empty?
+      _response.try(:sanitized_response_body).blank?
+    end
+
+    def persisted?
+      id.present?
+    end
+
+    def new_record?
+      !persisted?
+    end
+
+    def success?
+      _response.success? && !errors?
+    end
+
+    def errors?
+      errors.present?
+    end
+
+    def handle_response(response)
+      if response.unprocessable_entity?
+        rebuild_resource_from_response(response).tap do |resource|
+          resource.assign_errors_from_response response
+        end
+      else
+        rebuild_resource_from_response(response)
+      end
+    end
+
+    def assign_response(response)
+      @_response = response
+    end
+
+    def assign_errors_from_response(response)
+      assign_errors response.error_messages_response_body
+    end
+
+    private
+
+    def assign_errors(error_messages)
+      return unless error_messages.respond_to? :each
+
+      error_messages.each do |attribute, attribute_errors|
+        attribute_errors.each do |error|
+          self.errors.add attribute, error
+        end
+      end
+    end
+
+  end
+end