stockboy 0.7.0 → 0.7.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 64fb63c74d214447769a32a463ccab05bc92516e
-  data.tar.gz: c79abf6d768765673e66503d5ed5cab1d89dade7
+  metadata.gz: 65b059955605b61f5eca5555bf69e013660fbc41
+  data.tar.gz: b23aa61607e930fe36b5920afe48b397aee52585
 SHA512:
-  metadata.gz: 55c4b8106f01b7f822915b4ce2e655c70afa4770a8e42794dea09345326d88a2a16edd00633fad2822a7054b7f58fee81064c00583ef93ccf0eaf849a63814de
-  data.tar.gz: f28bc29494c073b3b5570dc9294e089c25b15e549f8f4db5349dd0df0df310429a06d39e57dc5acf858ca90035f3bb85bb07c02a27adb4b08f6f92202f203799
+  metadata.gz: 303f8e62f4025c494049ec3a5bf5b9eb004809f433f503cdea7edde82012e48a1ff0871a5992a32bfd31990f9663fdbc8b7a55182f22474e96019f0b0732a9d3
+  data.tar.gz: 5c8dee0518d7c27137da5e40c01409f56c9c793a1a24150631013672176cff95750cf8c677e56ad5d9c46be44e90314591a10e3c4bf23693408f6d43f87492e8

data/.gitignore

@@ -3,6 +3,7 @@
 /.bundle
 /.yardoc
 /Gemfile.lock
+/coverage
 /pkg/*
 /doc
 /tags

data/.travis.yml

@@ -4,11 +4,16 @@ env:
   - CI=true
 rvm:
   - "1.9.3"
-  - "2.0.0"
   - "2.1.1"
   - "jruby-19mode"
   - "rbx"
+before_install:
+  - gem install bundler
 script: bundle exec rspec spec
 matrix:
   allow_failures:
-    - rvm: "rbx"
+    - rvm:
+      - "jruby-19mode"
+addons:
+  code_climate:
+    repo_token: 7591072ad04d7a8ee788ce9259baa284724740cab1ae9ca94c162a583acd8f10

data/CHANGELOG.md

@@ -1,5 +1,12 @@
 # Changelog
 
+## 0.7.1 / 2014-03-25
+
+* [ENHANCEMENT] Job initializes with an empty attribute map to allow adding
+* [ENHANCEMENT] Default to rails logger when loaded
+* [ENHANCEMENT] Use same configured logger for all provider clients
+* [BUGFIX]      Compatibility with Rubinius
+
 ## 0.7.0 / 2014-03-21
 
 * [FEATURE]     Add individual attribute mappings

data/Gemfile

@@ -4,14 +4,17 @@ gemspec
 unless ENV["CI"]
   group :debug do
     gem "pry"
-    gem "pry-debugger" if RUBY_VERSION.start_with? "1.9"
-    gem "pry-byebug" if RUBY_VERSION.start_with? "2."
   end
 end
 
 group :doc do
-  gem "redcarpet", "~> 1.0"
   gem "yard"
+  gem "kramdown"
+end
+
+group :test do
+  gem "simplecov", require: nil
+  gem "codeclimate-test-reporter", require: nil
 end
 
 platforms :rbx do

data/lib/stockboy/configurator.rb

@@ -162,7 +162,9 @@ module Stockboy
     #   filter :update, proc{ true } # capture all remaining items
     #
     def filter(key, callable=nil, *args, &block)
-      @config[:filters][key] = block || Filters.build(callable, args)
+      filter = Filters.build(callable, args, block) || block
+      filter or raise ArgumentError, "Missing filter arguments for #{key}"
+      @config[:filters][key] = filter
     end
 
     # Register a trigger to notify the job of external events

data/lib/stockboy/filters.rb

@@ -6,15 +6,6 @@ module Stockboy
   #
   module Filters
     extend Stockboy::Registry
-
-    def self.build(callable, args)
-      if callable.is_a?(Symbol)
-        callable = find(callable)
-        callable = callable.new(*args) if callable.is_a? Class
-      end
-      callable
-    end
-
   end
 
 end

data/lib/stockboy/job.rb

@@ -83,7 +83,7 @@ module Stockboy
     def initialize(params={}, &block)
       @provider   = params[:provider]
       @reader     = params[:reader]
-      @attributes = params[:attributes]
+      @attributes = params[:attributes] || AttributeMap.new
       @filters    = FilterChain.new params[:filters]
       @triggers   = Hash.new { |h,k| h[k] = [] }
       @triggers.replace params[:triggers] if params[:triggers]
@@ -188,8 +188,8 @@ module Stockboy
     # @return [String]
     #
     def inspect
-      prov = "provider=#{(Stockboy::Providers.all.key(provider.class) || provider.class.to_s).inspect}"
-      read = "reader=#{(Stockboy::Readers.all.key(reader.class) || reader.class.to_s).inspect}"
+      prov = "provider=#{(Stockboy::Providers.all.key(provider.class) || provider.class)}"
+      read = "reader=#{(Stockboy::Readers.all.key(reader.class) || reader.class)}"
       attr = "attributes=#{attributes.map(&:to)}"
       filt = "filters=#{filters.keys}"
       cnts = "record_counts=#{record_counts}"

data/lib/stockboy/provider.rb

@@ -33,14 +33,6 @@ module Stockboy
   class Provider
     extend Stockboy::DSL
 
-    # Default logger if none is provided to the instance
-    #
-    # @return [Logger]
-    #
-    def self.logger
-      Logger.new(STDERR)
-    end
-
     # @return [Logger]
     #
     attr_accessor :logger
@@ -49,6 +41,12 @@ module Stockboy
     #
     attr_reader :errors
 
+    # Size of the received data
+    #
+    # @return [Time]
+    #
+    attr_reader :data_size
+
     # Timestamp of the received data
     #
     # @return [Time]

data/lib/stockboy/provider_repeater.rb

@@ -36,11 +36,10 @@ module Stockboy
             raise ArgumentError, "expected Provider, got #{provider.class}"
           end
         rescue StopIteration
-          return $!.result
+          return provider
         end
-        y = yield provider
+        yield provider
         provider.clear
-        enum.feed y
       end
     end
 

data/lib/stockboy/providers/file.rb

@@ -56,16 +56,7 @@ module Stockboy::Providers
     end
 
     def matching_file
-      return @matching_file if @matching_file
-      files = case file_name
-      when Regexp
-        Dir.entries(file_dir)
-            .select { |i| i =~ file_name }
-            .map { |i| ::File.join(file_dir, i) }
-      when String
-        Dir[::File.join(file_dir, file_name)]
-      end
-      @matching_file = pick_from(files.sort) if files.any?
+      @matching_file ||= pick_from(file_list.sort)
     end
 
     def clear
@@ -81,11 +72,7 @@ module Stockboy::Providers
       errors << "file #{file_name} not found" unless matching_file
       data_file = ::File.new(matching_file, 'r') if matching_file
       validate_file(data_file)
-      if valid?
-        logger.info "Getting file #{file_dir}/#{matching_file}"
-        @data = data_file.read
-        logger.info "Got file #{file_dir}/#{matching_file} (#{@data_size} bytes)"
-      end
+      @data = data_file.read if valid?
     end
 
     def validate
@@ -98,6 +85,21 @@ module Stockboy::Providers
       !!@matching_file
     end
 
+    def file_list
+      case file_name
+      when Regexp
+        Dir.entries(file_dir)
+           .select { |i| i =~ file_name }
+           .map    { |i| full_path(i) }
+      when String
+        Dir[full_path(file_name)]
+      end
+    end
+
+    def full_path(file_name)
+      ::File.join(file_dir, file_name)
+    end
+
     def validate_file(data_file)
       return errors << "no matching files" unless data_file
       validate_file_newer(data_file)
@@ -106,24 +108,33 @@ module Stockboy::Providers
     end
 
     def validate_file_newer(data_file)
-      @data_time ||= data_file.mtime
-      if file_newer && @data_time < file_newer
+      read_data_time(data_file)
+      if file_newer && data_time < file_newer
         errors << "no new files since #{file_newer}"
       end
     end
 
     def validate_file_smaller(data_file)
-      @data_size ||= data_file.size
-      if file_smaller && @data_size > file_smaller
+      read_data_size(data_file)
+      if file_smaller && data_size > file_smaller
         errors << "file size larger than #{file_smaller}"
       end
     end
 
     def validate_file_larger(data_file)
-      @data_size ||= data_file.size
-      if file_larger && @data_size < file_larger
+      read_data_size(data_file)
+      if file_larger && data_size < file_larger
         errors << "file size smaller than #{file_larger}"
       end
     end
+
+    def read_data_size(file)
+      @data_size ||= file.size
+    end
+
+    def read_data_time(file)
+      @data_time ||= file.mtime
+    end
+
   end
 end

data/lib/stockboy/providers/ftp.rb

@@ -148,9 +148,9 @@ module Stockboy::Providers
       client do |ftp|
         validate_file(matching_file)
         if valid?
-          logger.info "FTP getting file #{host} #{file_dir}/#{matching_file}"
+          logger.debug "FTP getting file #{inspect_matching_file}"
           @data = ftp.get(matching_file, nil)
-          logger.info "FTP got file #{host} #{file_dir}/#{matching_file} (#{@data_size} bytes)"
+          logger.debug "FTP got file #{inspect_matching_file} (#{data_size} bytes)"
         end
       end
       !@data.nil?
@@ -202,5 +202,9 @@ module Stockboy::Providers
         errors << "File size smaller than #{file_larger}"
       end
     end
+
+    def inspect_matching_file
+      "#{host} #{file_dir}/#{matching_file}"
+    end
   end
 end

data/lib/stockboy/providers/http.rb

@@ -125,8 +125,12 @@ module Stockboy::Providers
     end
 
     def client
-      return HTTPI unless block_given?
-      yield HTTPI
+      orig_logger, HTTPI.logger = HTTPI.logger, logger
+      req = HTTPI::Request.new(uri)
+      req.auth.basic(username, password) if username && password
+      yield req if block_given?
+      HTTPI.logger = orig_logger
+      req
     end
 
     private
@@ -138,14 +142,13 @@ module Stockboy::Providers
     end
 
     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 << "HTTP response error: #{response.code}"
-      else
-        @data = response.body
+      client do |request|
+        response = HTTPI.request(method, request)
+        if response.error?
+          errors << "HTTP response error: #{response.code}"
+        else
+          @data = response.body
+        end
       end
     end
 

data/lib/stockboy/providers/imap.rb

@@ -170,34 +170,35 @@ module Stockboy::Providers
       end
     end
 
-    # Purge the email from the mailbox corresponding to the [#matching_file]
+    # Purge the email from the mailbox corresponding to the [#message_key]
     #
-    # This can only be called after selecting the matching file to confirm the
-    # selected item, or after fetching the data
+    # This can only be called after selecting the message_key to confirm the
+    # selected item, or after fetching the data.
     #
     def delete_data
-      raise Stockboy::OutOfSequence, "must confirm #matching_message or calling #data" unless picked_matching_message?
+      picked_message_key? or raise Stockboy::OutOfSequence,
+        "must confirm #message_key or calling #data"
 
-      logger.info "Deleting message #{username}:#{host} message_uid: #{matching_message}"
       client do |imap|
-        imap.uid_store(matching_message, "+FLAGS", [:Deleted])
+        logger.info "Deleting message #{inspect_message_key}"
+        imap.uid_store(message_key, "+FLAGS", [:Deleted])
         imap.expunge
       end
     end
 
     # IMAP message id for the email that contains the selected data to process
     #
-    def matching_message
-      return @matching_message if @matching_message
+    def message_key
+      return @message_key if @message_key
       message_ids = search(default_search_options)
-      @matching_message = pick_from(message_ids) unless message_ids.empty?
+      @message_key = pick_from(message_ids) unless message_ids.empty?
     end
 
     # Clear received data and allow for selecting a new item from the server
     #
     def clear
       super
-      @matching_message = nil
+      @message_key = nil
       @data_time = nil
       @data_size = nil
     end
@@ -237,21 +238,35 @@ module Stockboy::Providers
 
     def fetch_data
       client do |imap|
-        return false unless matching_message
-        mail = ::Mail.new(imap.fetch(matching_message, 'RFC822')[0].attr['RFC822'])
-        if part = mail.attachments.detect { |part| validate_attachment(part) }
-          validate_file(part.decoded)
-          if valid?
-            logger.info "Getting file from #{username}:#{host} message_uid #{matching_message}"
-            @data = part.decoded
+        open_message(message_key) do |mail|
+          open_attachment(mail) do |part|
+            logger.debug "Getting file from #{inspect_message_key}"
+            @data = part
             @data_time = normalize_imap_datetime(mail.date)
-            logger.info "Got file from #{username}:#{host} message_uid #{matching_message}"
+            logger.debug "Got file from #{inspect_message_key}"
           end
         end
       end
       !@data.nil?
     end
 
+    def open_message(id)
+      return unless id
+      client do |imap|
+        imap_message = imap.fetch(id, 'RFC822').first or return
+        mail = ::Mail.new(imap_message.attr['RFC822'])
+        yield mail if block_given?
+        mail
+      end
+    end
+
+    def open_attachment(mail)
+      part = mail.attachments.detect { |part| validate_attachment(part) }
+      validate_file(part) if part or return
+      yield part.decoded if valid?
+      part
+    end
+
     def validate
       errors << "host must be specified" if host.blank?
       errors << "username must be specified" if username.blank?
@@ -259,8 +274,8 @@ module Stockboy::Providers
       errors.empty?
     end
 
-    def picked_matching_message?
-      !!@matching_message
+    def picked_message_key?
+      !!@message_key
     end
 
     def validate_attachment(part)
@@ -289,18 +304,26 @@ module Stockboy::Providers
     end
 
     def validate_file_smaller(data_file)
-      @data_size ||= data_file.bytesize
-      if file_smaller && @data_size > file_smaller
+      read_data_size(data_file)
+      if file_smaller && data_size > file_smaller
         errors << "File size larger than #{file_smaller}"
       end
     end
 
     def validate_file_larger(data_file)
-      @data_size ||= data_file.bytesize
-      if file_larger && @data_size < file_larger
+      read_data_size(data_file)
+      if file_larger && data_size < file_larger
         errors << "File size smaller than #{file_larger}"
       end
     end
+
+    def read_data_size(data_file)
+      @data_size ||= data_file.body.raw_source.bytesize
+    end
+
+    def inspect_message_key
+      "#{username}:#{host} message_uid #{message_key}"
+    end
   end
 
 end