stockboy 0.5.7 → 0.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 18c67d713e1473f435d7bcc26378aa766d9f6243
-  data.tar.gz: 0d82139b4018daeb8ce12a139e5bc7f8c808d679
+  metadata.gz: 025d746c97ca5ded5e263969f5faf3fa215dbaa6
+  data.tar.gz: febec727068f490b15846a93912d625f91ad048b
 SHA512:
-  metadata.gz: f63f685efb55c6eda528d3bd630c481e68d6961a36c83e0b8e5e72ecf09deddd9027e1143ee33ca5ae63094a026c3ea7c1748900b8ea446e308d980c7111c94d
-  data.tar.gz: bc63a44fc29399fa614afc15bf3bf282b9587bfc3a552f344411eb262fcd4701d243324d20a7d9d13b71d534baeb531b3cb93358c743a31ece6971717a644bc9
+  metadata.gz: 8fa25cb4d7326baaa6de53c0b4160663a5f0523e5dc7a6132904e6f11bac32d72b69d7328c7a563129b17b37440756d704be45d5f7cfe3b57673f32bdb25e1cd
+  data.tar.gz: 9dd0a0bd18b9b5b198f8aff1a90e649a3ffc8acb4b62b7aa4fd305908de6e8a3826f439ea4894a82f195692e14578513c84ced4942a5818b57eade3afd1f1687

data/CHANGELOG.md

@@ -1,5 +1,10 @@
 # Changelog
 
+## 0.6.0 / 2014-02-06
+
+* [FEATURE]     Support HTTP basic authentication (@markedmondson)
+* [ENHANCEMENT] Accept any duck-typed hash-like input when building a record
+
 ## 0.5.7 / 2013-12-13
 
 * [BUGFIX]      Fix IMAP search with missing search defaults

data/lib/stockboy/candidate_record.rb

@@ -17,7 +17,7 @@ module Stockboy
     #
     def initialize(attrs, map)
       @map = map
-      @table = use_frozen_keys(attrs, map)
+      @table = reuse_frozen_hash_keys(attrs, map)
       @tr_table = Hash.new
       freeze
     end
@@ -114,11 +114,24 @@ module Stockboy
       @tr_table[col.to] = translated.public_send(col.to)
     end
 
+    # Clean output values that are a subclass of a standard type
+    #
     def sanitize(value)
-      value.is_a?(String) ? value.to_s : value
+      case value
+      when String # e.g. Nori::StringWithAttributes
+        value.to_s
+      else
+        value
+      end
     end
 
-    def use_frozen_keys(attrs, map)
+    # Optimization to reuse the same hash key string instances
+    #
+    # The need for this is fixed for CSV in: https://bugs.ruby-lang.org/issues/9143
+    # (ruby >= 2.1) and can be managed by applying str.freeze in other readers.
+    #
+    def reuse_frozen_hash_keys(attrs, map)
+      return attrs unless attrs.is_a? Hash
       attrs.reduce(Hash.new) do |new_hash, (field, value)|
         key = map.attribute_from(field).from
         new_hash[key] = value

data/lib/stockboy/providers/http.rb

@@ -42,9 +42,27 @@ module Stockboy::Providers
     #
     dsl_attr :method, attr_writer: false
 
+    # User name for basic auth connection credentials
+    #
+    # @!attribute [rw] username
+    # @return [String]
+    # @example
+    #   username "arthur"
+    #
+    dsl_attr :username
+
+    # Password for basic auth connection credentials
+    #
+    # @!attribute [rw] password
+    # @return [String]
+    # @example
+    #   password "424242"
+    #
+    dsl_attr :password
+
     def uri
       return nil if @uri.nil? || @uri.empty?
-      URI(@uri).tap { |u| u.query = URI.encode_www_form(@query) }
+      URI(@uri).tap { |u| u.query = URI.encode_www_form(@query) if @query }
     end
 
     def uri=(uri)
@@ -84,15 +102,25 @@ module Stockboy::Providers
       @uri = uri
     end
 
+    def username=(username)
+      @username = username
+    end
+
+    def password=(password)
+      @password = password
+    end
+
     # @!endgroup
 
     # Initialize an HTTP provider
     #
     def initialize(opts={}, &block)
       super(opts, &block)
-      self.uri    = opts[:uri]
-      self.method = opts[:method] || :get
-      self.query  = opts[:query]  || Hash.new
+      self.uri      = opts[:uri]
+      self.method   = opts[:method] || :get
+      self.query    = opts[:query]  || Hash.new
+      self.username = opts[:username]
+      self.password = opts[:password]
       DSL.new(self).instance_eval(&block) if block_given?
     end
 
@@ -111,6 +139,7 @@ module Stockboy::Providers
     def fetch_data
       request = HTTPI::Request.new
       request.url = uri
+      request.auth.basic(username, password) if username && password
       response = HTTPI.send(method, request)
       if response.error?
         errors.add :response, "HTTP respone error: #{response.code}"

data/lib/stockboy/version.rb

@@ -1,3 +1,3 @@
 module Stockboy
-  VERSION = "0.5.7"
+  VERSION = "0.6.0"
 end

data/spec/stockboy/providers/http_spec.rb

@@ -33,6 +33,14 @@ module Stockboy
       provider.method.should == :post
     end
 
+    it "should assign basic auth parameters" do
+      provider.username = "username"
+      provider.password = "password"
+
+      provider.username.should == "username"
+      provider.password.should == "password"
+    end
+
     describe ".new" do
       its(:errors) { should be_empty }
 
@@ -78,6 +86,16 @@ module Stockboy
 
         provider.data.should == '{"success":true}'
       end
+
+      it "should setup basic auth if a username and password are supplied" do
+        provider.username = "username"
+        provider.password = "password"
+
+        allow(HTTPI).to receive(:request) { response }
+        expect_any_instance_of(HTTPI::Auth::Config).to receive(:basic).with("username", "password")
+
+        provider.data.should == '{"success":true}'
+      end
     end
 
     describe "#client" do

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: stockboy
 version: !ruby/object:Gem::Version
-  version: 0.5.7
+  version: 0.6.0
 platform: ruby
 authors:
 - Andrew Vit
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-12-13 00:00:00.000000000 Z
+date: 2014-02-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -249,7 +249,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: stockboy
-rubygems_version: 2.0.14
+rubygems_version: 2.2.1
 signing_key: 
 specification_version: 4
 summary: Multi-source data normalization library