artirix_data_models 0.6.3.1 → 0.6.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 6bf75f8fabe2f1161d1306a0c1d1da33abc2e178
-  data.tar.gz: 033a3edd3d4ec0c2cb5158ec3fda73a05e9a6c7f
+  metadata.gz: cacb0976cda27f75c2646ca38836457d6e48af28
+  data.tar.gz: 1427115dc8b1cf019e2adaa8fb6aca3c9d68e417
 SHA512:
-  metadata.gz: 8957ef6dae32230c8dd3c7223f8b2473fba7f70f969cd0585d53bf0008d62b9164d158b1e2fd0c30e19c0c4c5a77e1ff3f71b0c2b060de137725e695faf81e35
-  data.tar.gz: f26f34e27de7508872b7b5ca6a6f8d0a36f740848b6bd900aa6449d21738e975b67a66e1970eb39a25504152fbc92b6074adfce1fc64ca49f85715cff59ac80a
+  metadata.gz: edf05df3fc6916f662f0e1476af6940f95e0fb6227882cc180b6cb4372f8706a99eeb0f39bff7c106b135a3042425e5b9ccad54a986b56d4832558b78fb800e9
+  data.tar.gz: f8c13e33e16c6a5e7b4c325ffa2fa63f145de85a9f4a3250a9fe269f4c4026247d679148bf8fdeb3c43de5e7792b44d069d50fd2a9e3652b8a468dcd6ddc52e6

data/Gemfile

@@ -4,6 +4,7 @@ source 'https://rubygems.org'
 gemspec
 
 group :development, :test do
+  gem 'rubocop'
   gem 'pry'
   gem 'pry-nav'
   gem 'pry-stack_explorer'

data/README.md

@@ -7,12 +7,12 @@
 [![Code Climate Coverage](https://codeclimate.com/github/artirix/artirix_data_models/coverage.png)](https://codeclimate.com/github/artirix/artirix_data_models)
 
 
-This gem provides the tools for building Data Models (ActiveModel compliant objects that only receive attributes on initialisation), 
-with their DAOs (Data Access Objects, the ones responsible for loading them up), the EsCollection objects (collection of 
+This gem provides the tools for building Data Models (ActiveModel compliant objects that only receive attributes on initialisation),
+with their DAOs (Data Access Objects, the ones responsible for loading them up), the EsCollection objects (collection of
 objects, paginatable and with extra features), and tools that allow them to work.
 
 Its goal is to provide a set of Read Only model objects that receive their data from some sort of Data API.
- 
+
 It's designed to work assuming JSON APIs and ElasticSearch responses.
 
 # TODO:
@@ -22,6 +22,32 @@ It's designed to work assuming JSON APIs and ElasticSearch responses.
 
 ## Usage
 
+### Connection
+
+You have to specify the location of data-layer. It can be done in the config like this:
+
+```ruby
+SimpleConfig.for(:site) do
+  group :data_gateway do
+    set :url, 'http://super-secure-domain-123456.com'
+  end
+end
+```
+
+If the connection is covered by basic authentication it can be set by adding ```login``` and ```password``` settings.
+
+Example:
+
+```ruby
+SimpleConfig.for(:site) do
+  group :data_gateway do
+    set :url, 'http://super-secure-domain-123456.com'
+    set :login, 'WhiteCat'
+    set :password, 'B@dPassword!'
+  end
+end
+```
+
 ### Model
 
 TODO:
@@ -40,7 +66,7 @@ TODO:
 
 ### The Registry
 
-Your app should extend the `ArtirixDataModels::DAORegistry`. We can override the `setup_config` method to add extra loaders. 
+Your app should extend the `ArtirixDataModels::DAORegistry`. We can override the `setup_config` method to add extra loaders.
 
 **important: do not forget to call `super` on `setup_config`.**
 
@@ -70,7 +96,7 @@ end
 
 ### initializer
 
-An initializer should be added for extra configuration. 
+An initializer should be added for extra configuration.
 
 We can enable pagination with either `will_paginate` or `kaminari`.
 
@@ -153,8 +179,8 @@ end
 #### Custom DAO Registry
 
 For the use of a custom DAO Registry, it is recomended to actually require it on the test helper:
- 
- 
+
+
 in spec/rails_helper.rb:
 
 ```ruby
@@ -194,7 +220,7 @@ end
 In order to use FactoryGirl with these Models, we need to specify:
 
 1. the objects cannot be saved, so we need to specify `skip_create` to avoid it.
-2. the setting of the data is only to be done on the model's initialisation, not with public setters. 
+2. the setting of the data is only to be done on the model's initialisation, not with public setters.
 For that, we need to specify: `initialize_with { new(attributes) }`
 
 ```ruby
@@ -203,11 +229,11 @@ FactoryGirl.define do
   factory :article do
     # no save call
     skip_create
-    
+
     # in our models we have private setters -> we need the attributes to be
     # passed on object initialisation
     initialize_with { new(attributes) }
-    
+
     sequence(:id)
     title { Faker::Lorem.sentence }
   end
@@ -224,6 +250,10 @@ end
 
 ## Changes
 
+### 0.6.4
+
+- Add ability to create connection to data source using HTTP Basic Authentication.
+
 ### 0.6.3.1
 
 - Fix in EsCollection's aggregation parsing (nested + single from RAW now work ok)
@@ -253,7 +283,7 @@ Yanked because of typo bug on SortedBucketAggregationBase. Released 0.6.3.1 with
 - `SortedBucketAggregationBase` introduced. now `ArtirixDataModels::AggregationsFactory.sorted_aggregation_class_based_on_index_on(index_array)` available to create a class for Aggregations which will sort the buckets based on the position of the elements on a given array.
 
 
-### ~0.6.1~ 
+### ~0.6.1~
 
 Yanked because of breaking change introduction: removal of `Aggregation.from_json` method
 

data/lib/artirix_data_models/gateways/data_gateway.rb

@@ -104,18 +104,36 @@ class ArtirixDataModels::DataGateway
   end
 
   module DefaultConnectionLoader
-    def self.default_connection
-      url = config_connection_url
-      Faraday.new(url: url, request: { params_encoder: Faraday::FlatParamsEncoder }) do |faraday|
-        faraday.request :url_encoded # form-encode POST params
-        faraday.response :logger # log requests to STDOUT
-        faraday.adapter Faraday.default_adapter
+
+    class << self
+      attr_accessor :config
+
+      def default_connection
+        url = connection_url
+
+        Faraday.new(url: url, request: { params_encoder: Faraday::FlatParamsEncoder }) do |faraday|
+          faraday.request :url_encoded # form-encode POST params
+          faraday.response :logger # log requests to STDOUT
+          faraday.basic_auth(config.login, config.password) if basic_auth?
+          faraday.adapter Faraday.default_adapter
+        end
       end
-    end
 
-    def self.config_connection_url
-      SimpleConfig.for(:site).data_gateway.url
+      # Configuration access
+
+      def config
+        @config ||= SimpleConfig.for(:site).data_gateway
+      end
+
+      def connection_url
+        config.url
+      end
+
+      def basic_auth?
+        config.respond_to?(:login) && config.respond_to?(:password)
+      end
     end
+
   end
 
   class Error < StandardError

data/lib/artirix_data_models/version.rb

@@ -1,3 +1,3 @@
 module ArtirixDataModels
-  VERSION = '0.6.3.1'
+  VERSION = '0.6.4'
 end

data/spec/artirix_data_models/gateways/data_gateway_spec.rb

@@ -17,6 +17,30 @@ RSpec.describe ArtirixDataModels::DataGateway, type: :model do
       When(:gateway) { described_class.new }
       Then { gateway.connection.url_prefix.to_s == connection_url }
     end
+
+    context 'basic auth connection' do
+      Given(:connection_url) { 'http://example.com/other' }
+      Given(:basic_login)    { 'WhiteCat' }
+      Given(:basic_password) { 'B@dPassword!' }
+
+      Given do
+        url      = connection_url
+        login    = basic_login
+        password = basic_password
+
+        SimpleConfig.for(:site) do
+          group :data_gateway do
+            set :url, url
+            set :login, login
+            set :password, password
+          end
+        end
+      end
+
+      When(:gateway) { described_class.new }
+      Then { expect(gateway.connection.url_prefix.to_s).to eq(connection_url) }
+      Then { expect(gateway.connection.headers).to have_key('Authorization') }
+    end
   end
 
   context 'requests' do

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: artirix_data_models
 version: !ruby/object:Gem::Version
-  version: 0.6.3.1
+  version: 0.6.4
 platform: ruby
 authors:
 - Eduardo Turiño
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-08-13 00:00:00.000000000 Z
+date: 2015-09-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport