dhs 1.0.0

data/lib/dhs/problems/nested/base.rb

@@ -0,0 +1,54 @@
+# frozen_string_literal: true
+
+module DHS::Problems
+  module Nested
+    module Base
+      # Filters base errors by scope
+      # and reduces key by given scope name;
+      # returns plain array if end of tree is reached
+      def nest(messages, scope = nil)
+        scope = translate_rails_to_api_scope(scope)
+        return messages unless scope
+        messages = messages.select do |key, _|
+          key.match(/^#{scope}/)
+        end
+        # if only one key and this key has no dots, exit with plain
+        if reached_leaf?(messages)
+          messages.first[1]
+        else
+          remove_scope(messages, scope)
+        end
+      end
+
+      # Identifies if the end of nested errors tree is reached
+      def reached_leaf?(messages)
+        messages.keys.length == 1 &&
+          !messages.first[0].match(/\./)
+      end
+
+      # Removes scope from given messages' key
+      def remove_scope(messages, scope)
+        messages.each_with_object({}) do |element, hash|
+          key = element[0].to_s.gsub(/^#{scope}\./, '')
+          hash[key.to_sym] = element[1]
+        end
+      end
+
+      # Translates rails like accessors for collections
+      # like first, second, last to api error paths
+      def translate_rails_to_api_scope(scope)
+        case scope
+        when :first
+          0
+        when :second
+          1
+        when :last
+          return values.length - 1 if messages.present?
+          0
+        else
+          scope
+        end
+      end
+    end
+  end
+end

data/lib/dhs/problems/nested/errors.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+module DHS::Problems
+  module Nested
+    class Errors < DHS::Problems::Errors
+      include DHS::Problems::Nested::Base
+
+      def initialize(errors, scope)
+        @raw = errors
+        @messages = nest(errors.messages, scope)
+        @message = errors.message
+        @scope = scope
+      end
+    end
+  end
+end

data/lib/dhs/problems/nested/warnings.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+module DHS::Problems
+  module Nested
+    class Warnings < DHS::Problems::Warnings
+      include DHS::Problems::Nested::Base
+
+      def initialize(warnings, scope)
+        @raw = warnings.raw
+        @messages = nest(warnings.messages, scope)
+        @scope = scope
+      end
+    end
+  end
+end

data/lib/dhs/problems/warnings.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+module DHS::Problems
+  class Warnings < Base
+
+    def initialize(raw, record = nil)
+      @raw = raw
+      @record = record
+      @codes = {}.with_indifferent_access
+      @messages = warnings_from_raw
+    end
+
+    private
+
+    def warnings_from_raw
+      messages = {}
+      return messages if !raw.is_a?(Hash) || raw[:field_warnings].blank?
+      raw[:field_warnings].each do |field_warning|
+        add_error(messages, field_warning[:path].join('.').to_sym, field_warning[:code])
+      end
+      messages.with_indifferent_access
+    end
+  end
+end

data/lib/dhs/proxy.rb

@@ -0,0 +1,69 @@
+# frozen_string_literal: true
+
+# Proxy makes different kind of data accessible
+# If href is present it also alows loading/reloading
+class DHS::Proxy
+  autoload :Accessors,
+    'dhs/concerns/proxy/accessors'
+  autoload :Create,
+    'dhs/concerns/proxy/create'
+  autoload :Problems,
+    'dhs/concerns/proxy/problems'
+  autoload :Link,
+    'dhs/concerns/proxy/link'
+
+  include Accessors
+  include Create
+  include Link
+  include Problems
+
+  # prevent clashing with attributes of underlying data
+  attr_accessor :_data, :_loaded
+
+  delegate :_record, :becomes, to: :_data, allow_nil: true
+
+  def initialize(data)
+    self._data = data
+    self._loaded = false
+  end
+
+  def record
+    _data.class
+  end
+
+  def load!(options = nil)
+    return self if _loaded
+    reload!(options)
+  end
+
+  def reload!(options = nil)
+    options = {} if options.blank?
+    data = _data.class.request(
+      options.merge(method: :get).merge(reload_options)
+    )
+    _data.merge_raw!(data.unwrap(:item_key))
+    self._loaded = true
+    return becomes(_record) if _record
+    self
+  end
+
+  private
+
+  def as_record
+    @as_record ||= becomes(_record)
+  end
+
+  def reload_options
+    return { url: _data.href } if _data.href
+    return { params: { id: as_record.id } } if as_record.id
+    {}
+  end
+
+  def merge_data_with_options(data, options)
+    if options && options[:params]
+      data.merge(options[:params])
+    else
+      data
+    end
+  end
+end

data/lib/dhs/railtie.rb

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+module DHS
+  class Railtie < Rails::Railtie
+    initializer 'dhs.hook_into_controller_initialization' do
+      class ActionController::Base
+
+        def initialize
+          prepare_dhs_request_cycle_cache
+          reset_option_blocks
+          reset_extended_rollbar_request_logs
+          super
+        end
+
+        private
+
+        def prepare_dhs_request_cycle_cache
+          return unless DHS.config.request_cycle_cache_enabled
+          DHS::Interceptors::RequestCycleCache::ThreadRegistry.request_id = [Time.now.to_f, request.object_id].join('#')
+        end
+
+        def reset_option_blocks
+          DHS::OptionBlocks::CurrentOptionBlock.options = nil
+        end
+
+        def reset_extended_rollbar_request_logs
+          return unless defined?(::Rollbar)
+          return unless DHC.config.interceptors.include?(DHS::Interceptors::ExtendedRollbar::Interceptor)
+          DHS::Interceptors::ExtendedRollbar::ThreadRegistry.log = []
+        end
+      end
+    end
+  end
+end

data/lib/dhs/record.rb

@@ -0,0 +1,112 @@
+# frozen_string_literal: true
+
+class DHS::Record
+  autoload :AttributeAssignment,
+    'dhs/concerns/record/attribute_assignment'
+  autoload :Batch,
+    'dhs/concerns/record/batch'
+  autoload :Chainable,
+    'dhs/concerns/record/chainable'
+  autoload :Configuration,
+    'dhs/concerns/record/configuration'
+  autoload :Create,
+    'dhs/concerns/record/create'
+  autoload :CustomSetters,
+    'dhs/concerns/record/custom_setters'
+  autoload :Destroy,
+    'dhs/concerns/record/destroy'
+  autoload :Endpoints,
+    'dhs/concerns/record/endpoints'
+  autoload :Equality,
+    'dhs/concerns/record/equality'
+  autoload :Find,
+    'dhs/concerns/record/find'
+  autoload :FindBy,
+    'dhs/concerns/record/find_by'
+  autoload :First,
+    'dhs/concerns/record/first'
+  autoload :HrefFor,
+    'dhs/concerns/record/href_for'
+  autoload :Last,
+    'dhs/concerns/record/last'
+  autoload :Mapping,
+    'dhs/concerns/record/mapping'
+  autoload :Merge,
+    'dhs/concerns/record/merge'
+  autoload :Model,
+    'dhs/concerns/record/model'
+  autoload :Pagination,
+    'dhs/concerns/record/pagination'
+  autoload :Provider,
+    'dhs/concerns/record/provider'
+  autoload :Request,
+    'dhs/concerns/record/request'
+  autoload :Relations,
+    'dhs/concerns/record/relations'
+  autoload :Scope,
+    'dhs/concerns/record/scope'
+  autoload :Tracing,
+    'dhs/concerns/record/tracing'
+  autoload :Update,
+    'dhs/concerns/record/update'
+
+  include AttributeAssignment
+  include Batch
+  include Chainable
+  include Configuration
+  include Create
+  include CustomSetters
+  include Destroy
+  include Endpoints
+  include Equality
+  include Find
+  include FindBy
+  include First
+  include HrefFor
+  include DHS::IsHref
+  include Last
+  include DHS::Inspect
+  include Mapping
+  include Merge
+  include Model
+  include Pagination
+  include Provider
+  include Request
+  include Relations
+  include Scope
+  include Tracing
+  include Update
+
+  delegate :_proxy, :_endpoint, :merge_raw!, :select, :becomes, :respond_to?, to: :_data
+
+  def initialize(data = nil, apply_customer_setters = true)
+    data ||= DHS::Data.new({}, nil, self.class)
+    data = DHS::Data.new(data, nil, self.class) unless data.is_a?(DHS::Data)
+    define_singleton_method(:_data) { data }
+    apply_custom_setters! if apply_customer_setters
+  end
+
+  def as_json(options = nil)
+    _data.as_json(options)
+  end
+
+  def self.build(data = nil)
+    new(data)
+  end
+
+  # Override Object#dup because it doesn't support copying any singleton
+  # methods, which leads to missing `_data` method when you execute `dup`.
+  def dup
+    clone
+  end
+
+  protected
+
+  def method_missing(name, *args, **keyword_args, &block)
+    _data.send(name, *args, **keyword_args, &block)
+  end
+
+  def respond_to_missing?(name, include_all = false)
+    _data.respond_to_missing?(name, include_all)
+  end
+end

data/lib/dhs/rspec.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+require 'dhs'
+require 'dhs/test/stubbable_records'
+
+RSpec.configure do |config|
+  config.before(:each) do
+    DHS.config.request_cycle_cache.clear
+  end
+end

data/lib/dhs/test/stubbable_records.rb

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+require 'local_uri'
+require 'webmock'
+
+class DHS::Record
+  DEFAULT_LIMIT = DHS::Pagination::Base::DEFAULT_LIMIT
+
+  def self.stub_all(url, items, options = {})
+    extend WebMock::API
+
+    items.each_slice(DEFAULT_LIMIT).with_index do |(*batch), index|
+      uri = LocalUri::URI.new(url)
+      uri.query.merge!(
+        limit_key(:parameter) => DEFAULT_LIMIT
+      )
+      offset = pagination_class.page_to_offset(index + 1, DEFAULT_LIMIT)
+      unless index.zero?
+        uri.query.merge!(
+          pagination_key(:parameter) => offset
+        )
+      end
+      request_stub = stub_request(:get, uri.to_s)
+      request_stub.with(options) if options.present?
+      request_stub.to_return(
+        body: {
+          items: batch,
+          offset: index.zero? ? 0 : offset,
+          total: items.length
+        }.to_json
+      )
+    end
+  end
+end

data/lib/dhs/unprocessable.rb

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+module DHS
+  class Unprocessable < StandardError
+  end
+end

data/lib/dhs/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module DHS
+  VERSION = '1.0.0'
+end

data/script/ci/build.sh

@@ -0,0 +1,18 @@
+#!/bin/bash -e
+
+# custom vars
+# RUBY = ruby-1.9.3-p125
+# GEMSET = location-app-${GitHub pull request id|branch name}
+# standard vars
+
+if [ -z "$SKIP_RVM" ]; then
+  [[ -s "/usr/local/rvm/scripts/rvm" ]] && . "/usr/local/rvm/scripts/rvm"
+  RUBY=${RUBY:-ruby-2.1.2}
+  GEMSET=${GEMSET:-DHS}
+  rvm use ${RUBY}@${GEMSET} --create
+  gem install bundler --no-rdoc --no-ri
+fi
+
+bundle install --local || bundle install
+RAILS_ENV=test bundle exec rspec
+rvm --force gemset delete ${RUBY}@${GEMSET}

data/spec/auto_oauth_spec.rb

@@ -0,0 +1,163 @@
+# frozen_string_literal: true
+
+require 'rails_helper'
+
+describe 'Auto OAuth Authentication', type: :request, dummy_models: true do
+  context 'without DHC::Auth interceptor enabled' do
+    before do
+      DHS.configure do |config|
+        config.auto_oauth = -> { access_token }
+      end
+    end
+
+    it 'shows a warning that it can not perform auto authentication' do
+      expect(lambda do
+        get '/automatic_authentication/oauth'
+      end).to output(
+        %r{\[WARNING\] Can't enable auto oauth as DHC::Auth interceptor is not enabled\/configured \(see https://github.com/DePayFi/dhc/blob/master/README.md#authentication-interceptor\)!}
+      ).to_stderr
+    end
+  end
+
+  context 'with DHC::Auth interceptor enabled' do
+    context 'with only one auth provider' do
+      let(:token) { ApplicationController::ACCESS_TOKEN }
+
+      let(:record_request) do
+        stub_request(:get, 'http://datastore/v2/records_with_oauth/1')
+          .with(
+            headers: { 'Authorization' => "Bearer #{token}" }
+          ).to_return(status: 200, body: { name: 'Record' }.to_json)
+      end
+
+      let(:records_request) do
+        stub_request(:get, 'http://datastore/v2/records_with_oauth?color=blue')
+          .with(
+            headers: { 'Authorization' => "Bearer #{token}" }
+          ).to_return(status: 200, body: { items: [{ name: 'Record' }] }.to_json)
+      end
+
+      before do
+        DHS.configure do |config|
+          config.auto_oauth = -> { access_token }
+        end
+        DHC.configure do |config|
+          config.interceptors = [DHC::Auth]
+        end
+        record_request
+        records_request
+      end
+
+      after do
+        DHC.config.reset
+      end
+
+      it 'applies OAuth credentials for the individual request automatically' do
+        get '/automatic_authentication/oauth'
+        expect(record_request).to have_been_requested
+        expect(records_request).to have_been_requested
+      end
+    end
+
+    context 'with multiple auth providers' do
+      before do
+        DHS.configure do |config|
+          config.auto_oauth = proc do
+            {
+              provider1: access_token_provider_1,
+              provider2: access_token_provider_2
+            }
+          end
+        end
+        DHC.configure do |config|
+          config.interceptors = [DHC::Auth]
+        end
+        record_request_provider_1
+        records_request_provider_2
+        records_request_per_endpoint_provider_1
+        record_request_per_endpoint_provider_2
+      end
+
+      let(:token) { ApplicationController::ACCESS_TOKEN }
+
+      let(:record_request_provider_1) do
+        stub_request(:get, 'http://datastore/v2/records_with_multiple_oauth_providers_1/1')
+          .with(
+            headers: { 'Authorization' => "Bearer #{token}_provider_1" }
+          ).to_return(status: 200, body: { name: 'Record' }.to_json)
+      end
+
+      let(:records_request_provider_2) do
+        stub_request(:get, 'http://datastore/v2/records_with_multiple_oauth_providers_2?color=blue')
+          .with(
+            headers: { 'Authorization' => "Bearer #{token}_provider_2" }
+          ).to_return(status: 200, body: { items: [{ name: 'Record' }] }.to_json)
+      end
+
+      let(:records_request_per_endpoint_provider_1) do
+        stub_request(:get, 'http://datastore/v2/records_with_multiple_oauth_providers_per_endpoint?color=blue')
+          .with(
+            headers: { 'Authorization' => "Bearer #{token}_provider_1" }
+          ).to_return(status: 200, body: { items: [{ name: 'Record' }] }.to_json)
+      end
+
+      let(:record_request_per_endpoint_provider_2) do
+        stub_request(:get, 'http://datastore/v2/records_with_multiple_oauth_providers_per_endpoint/1')
+          .with(
+            headers: { 'Authorization' => "Bearer #{token}_provider_2" }
+          ).to_return(status: 200, body: { name: 'Record' }.to_json)
+      end
+
+      after do
+        DHC.config.reset
+      end
+
+      it 'applies OAuth credentials for the individual request automatically no matter how many auth providers are configured ' do
+        get '/automatic_authentication/oauth_with_multiple_providers'
+        expect(record_request_provider_1).to have_been_requested
+        expect(records_request_provider_2).to have_been_requested
+        expect(records_request_per_endpoint_provider_1).to have_been_requested
+        expect(record_request_per_endpoint_provider_2).to have_been_requested
+      end
+    end
+
+    context 'with provider enabled for auto oauth' do
+      let(:token) { ApplicationController::ACCESS_TOKEN }
+
+      let(:record_request) do
+        stub_request(:get, 'http://internalservice/v2/records/1')
+          .with(
+            headers: { 'Authorization' => "Bearer #{token}" }
+          ).to_return(status: 200, body: { name: 'Record' }.to_json)
+      end
+
+      let(:records_request) do
+        stub_request(:get, 'http://internalservice/v2/records?color=blue')
+          .with(
+            headers: { 'Authorization' => "Bearer #{token}" }
+          ).to_return(status: 200, body: { items: [{ name: 'Record' }] }.to_json)
+      end
+
+      before do
+        DHS.configure do |config|
+          config.auto_oauth = -> { access_token }
+        end
+        DHC.configure do |config|
+          config.interceptors = [DHC::Auth]
+        end
+        record_request
+        records_request
+      end
+
+      after do
+        DHC.config.reset
+      end
+
+      it 'applies OAuth credentials for the individual request automatically' do
+        get '/automatic_authentication/oauth_with_provider'
+        expect(record_request).to have_been_requested
+        expect(records_request).to have_been_requested
+      end
+    end
+  end
+end