xively-rb-connector 0.1.3 → 0.1.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: a50ebc4f70611bff7ec5580415a211ab47e38a50
-  data.tar.gz: f718ea2b7572645c7b9819442c887f5d474e9d33
+  metadata.gz: 2242f1160f39605cefa4bdbe99eaa725662e6976
+  data.tar.gz: 60d227c0cb4ff27e962708db758883ee8ec35551
 SHA512:
-  metadata.gz: 4dd0cc6f2dc13b82397a3e797c25edca5997950890c1c57ece6d475e7e51bd6717864916b41f8889cd2c02a2502dee858d39257429f61822150a8bae93ce2f52
-  data.tar.gz: 3c63bccae09298f15bb74ac8be4e52176110bd8d3a6f424c0a66170e123406f20663dab6b806fa78f567c8cf98bddaeddb9bcc58cb738ef29210e4f9a5208f9f
+  metadata.gz: 503e83fb982140c09a987b025968c292416239f861bb77007d50103e1617ee800bae85cd971e9131e15e81bec03e37844e15ca513d1e47f98b8d7b03995c132b
+  data.tar.gz: 1c1cd2da6a717739211d002f6ef65753f9117cb87ce27316fdeabf8a013e2aa253289dc1d5efa4b4b656e25c00302fc48c8b20a78ef4bcb8ce3e9ed187bda5b6

data/lib/xively-rb-connector.rb

@@ -17,6 +17,11 @@ module XivelyConnector
     @@connection = Connection.new(options)
   end
 
+  # Lookup methods delegate to class methods
+  def self.connected?
+    not @@connection.nil?
+  end
+
   # Releases the connection
   def self.disconnect()
     @@connection = nil
@@ -28,16 +33,14 @@ module XivelyConnector
   end
 
   # Lookup methods delegate to class methods
-  def self.find_device_by_id(id, api_key=nil)
-    self.connect(:api_key => api_key) unless api_key.nil?
-    raise "Can not connect without an api_key or an existing connection." if self.connection.nil? and api_key.nil?
-    Device.find_by_id(id)
+  def self.find_device_by_id(id, options)
+    Device.find_by_id(id, options)
   end
 
 end
 
 require "xively-rb-connector/version"
-require "xively-rb-connector/logging"
+require "xively-rb-connector/logger"
 require "xively-rb-connector/connection"
 require "xively-rb-connector/device"
 require "xively-rb-connector/datastream"

data/lib/xively-rb-connector/connection.rb

@@ -3,12 +3,11 @@ require 'xively-rb'
 module XivelyConnector
 
   class Connection < Xively::Client
-    include XivelyConnector::Logging
 
     format :json
 
     # Mix in the ability to log
-    include XivelyConnector::Logging
+    include Logger
 
     attr_accessor :config
 

data/lib/xively-rb-connector/datastream.rb

@@ -11,7 +11,7 @@ module XivelyConnector
     attr :datapoint_buffer_size, :only_save_changes
 
     # Mix in the ability to log
-    include XivelyConnector::Logging
+    include Logger
 
     def initialize(options)
       @logger = options[:logger] || logger
@@ -26,15 +26,15 @@ module XivelyConnector
       super(data)
 
       # Set the default buffer size (1 reading per minute)
-      @datapoint_buffer_size = options[:datapoint_buffer_size] || 60
-      @only_save_changes = options[:only_save_changes] || true
+      @datapoint_buffer_size = options[:datapoint_buffer_size] || 1
+      @only_save_changes = options[:only_save_changes] || false
 
       # Initialize Xively::Datastream's datapoint array to allow shift style loading
       @datapoints = []
 
       # Fix the unit attribute assignments
-      @unit_symbol   = data['unit']['symbol']
-      @unit_label    = data['unit']['label']
+      @unit_symbol = data['unit']['symbol']
+      @unit_label  = data['unit']['label']
 
       # Cast the current value as a BigDecimal for casting strings and comparing to ints and floats
       @current_value = 0 if current_value.nil?

data/lib/xively-rb-connector/device.rb

@@ -2,37 +2,35 @@ require 'xively-rb'
 require 'json'
 require 'ostruct'
 
-
 module XivelyConnector
 
 # Extend https://github.com/xively-rb-connector/xively-rb
 class Device < Xively::Feed
 
-    # Mix in the ability to log
-    include XivelyConnector::Logging
+    attr_reader :datapoint_buffer_size, :only_save_changes
 
-    # Connect to a device by ID
-    def self.find(id, api_key=nil)
-      self.find_by_id(id, api_key)
-    end
+    # Mix in the ability to log
+    include Logger
 
     # Connect to a device by ID
-    def self.find_by_id(id, api_key=nil)
+    def self.find_by_id(id, options={})
 
       # First connect if necessary
-      XivelyConnector.connect(:api_key => api_key) unless api_key.nil?
-      raise "Can not connect without an api_key or an existing connection." if XivelyConnector.connection.nil? and api_key.nil?
+      unless XivelyConnector.connected?
+        raise XivelyConnectorError, "Can not connect without an api_key or an existing connection." unless options[:api_key]
+        XivelyConnector.connect(options)
+      end
 
       XivelyConnector.connection.logger.debug "Device.find_by_id(#{id})"
 
-      # Perform the lookup
-      response = XivelyConnector.connection.get("/v2/feeds/#{id}.json")
+      # Perform the lookup  and add the response
+      options[:response] = XivelyConnector.connection.get("/v2/feeds/#{id}.json")
 
-      if response.success?
-        self.new(:response => response)
+      if options[:response].success?
+        self.new(options)
       else
-        logger.error response.response
-        response.response
+        logger.error options[:response].response
+        options[:response].response
       end
     end
 
@@ -45,6 +43,8 @@ class Device < Xively::Feed
 
       # initialize parent
       data = options[:response]
+      @datapoint_buffer_size = options[:datapoint_buffer_size] || 1
+      @only_save_changes     = options[:only_save_changes] || false
       super(options[:response])
 
       # Convert date strings to ruby dates
@@ -87,7 +87,10 @@ class Device < Xively::Feed
           @datastreams << datastream
         elsif datastream.is_a?(Hash)
           #@datastreams << Datastream.new(datastream)
-          @datastreams << XivelyConnector::Datastream.new(:device => self, :data => datastream)
+          @datastreams << XivelyConnector::Datastream.new(:device => self,
+                                                          :data => datastream,
+                                                          :datapoint_buffer_size => datapoint_buffer_size,
+                                                          :only_save_changes => only_save_changes)
         end
       end
     end

data/lib/xively-rb-connector/logger.rb

@@ -0,0 +1,121 @@
+require 'logging'
+
+module XivelyConnector
+
+  @@global_logger = nil
+
+  # Returns true or false, reflecting whether a global logger is configured
+  def self.global_logger_configured?
+    (not @@global_logger.nil?)
+  end
+
+  # Returns true or false, reflecting whether a global logger is configured
+  def self.configure_global_logger(options={})
+
+    # Collect and validate log level
+    log_level = options[:log_level] || :debug
+    raise "Can not initialize global logger, because #{log_level.inspect} is an unrecognized log level." unless [:off, :all, :debug, :info, :warn, :error, :fatal].include?(log_level)
+    Logging.logger.root.level = log_level
+
+    # When set to true backtraces will be written to the logs
+    trace_exceptions = options[:trace_exceptions] || true
+    Logging.logger.root.trace = trace_exceptions
+
+    # Setup colorized output for stdout (this scheme was setup for a terminal with a black background)
+    # :black, :red, :green, :yellow, :blue, :magenta, :cyan, :white
+    # :on_black, :on_red, :on_green, :on_yellow, :on_blue, :on_magenta, :on_cyan, :on_white
+    # :blink, :bold, :underline, :underscore
+    stdout_colors = options[:stdout_colors] || {:levels => {
+        :debug  => :white,
+        :info  => [:white, :on_blue, :bold],
+        :warn  => [:black, :on_yellow, :bold] ,
+        :error => [:white, :on_red, :bold],
+        :fatal => [:white, :on_red, :bold, :blink]
+    },
+                                                :date => :yellow,
+                                                :logger => :cyan,
+                                                :message => :white}
+    Logging.color_scheme('stdout_colors', stdout_colors)
+
+    # Always log info to stdout
+    log_to_stdout = options[:log_to_stdout] || true
+    if log_to_stdout
+      Logging.logger.root.add_appenders Logging.appenders.stdout(
+                                            'stdout',
+                                            :layout => Logging.layouts.pattern(
+                                                #:pattern => '[%d] %-5l %c: %m\n',
+                                                :color_scheme => 'stdout_colors'
+                                            )
+                                        )
+    end
+
+    if options[:log_file]
+
+      # Make sure log directory exists
+      log_file = File.expand_path(options[:log_file])
+      log_dir  = File.dirname(log_file)
+      raise "The log file can not be created, because its directory does not exist #{log_dir}" if Dir.exists?(log_dir)
+
+      # Determine layout. The available layouts are :basic, :json, :yaml, or a pattern such as '[%d] %-5l: %m\n'
+      layout = options[:log_file_layout] || :basic
+      if options[:log_file_layout]
+        if layout == :basic
+          use_layout = Logging.layouts.basic
+        elsif layout == :json
+          use_layout = Logging.layouts.json
+        elsif layout == :yaml
+          use_layout = Logging.layouts.yaml
+        else
+          use_layout = Logging.layouts.pattern(:pattern => layout) # '[%d] %-5l: %m\n'
+        end
+      end
+
+      # Determine if this should be a single or rolling log file
+      rolling = options[:rolling_log_file_age] || false
+
+      # Build the file appender
+      if rolling
+        Logging.logger.root.add_appenders Logging.appenders.rolling_file(
+                                              'development.log',
+                                              :age    => rolling,
+                                              :layout => use_layout
+                                          )
+      else
+        # Non-rolling log file
+        Logging.logger.root.add_appenders Logging.appenders.file(log_file, :layout => use_layout)
+      end
+
+      # Growl on error
+      growl_on_error = options[:growl_on_error] || false
+      if options[:growl_on_error]
+        Logging.logger.root.add_appenders Logging.appenders.growl(
+                                              'growl',
+                                              :level  => :error,
+                                              :layout => Logging.layouts.pattern(:pattern => '[%d] %-5l: %m\n')
+                                          )
+      end
+
+    end
+    # Return the root logger
+    Logging.logger.root
+  end
+
+
+  module Logger
+
+    def logger
+      @logger ||= XivelyConnector::Logger.logger
+    end
+
+    def self.logger
+      @logger ||= self.configure_logger_for(self.class.name)
+    end
+
+    def self.configure_logger_for(classname)
+      XivelyConnector.configure_global_logger() unless XivelyConnector.global_logger_configured?
+      l = Logging.logger[classname]
+    end
+
+  end
+
+end

data/lib/xively-rb-connector/version.rb

@@ -7,7 +7,7 @@ module XivelyConnector
   module VERSION #:nodoc:
     MAJOR = 0
     MINOR = 1
-    PATCH = 3
+    PATCH = 4
 
     STRING = [MAJOR, MINOR, PATCH].join('.')
   end

data/xively-rb-connector.gemspec

@@ -34,7 +34,7 @@ web. Xively provides a fantastic development portal and prototyping accounts are
   spec.add_development_dependency "webmock"
 
   # Runtime dependencies
-  spec.add_runtime_dependency "log4r", "~> 1.1"
+  spec.add_runtime_dependency "logging", "~> 1.8"
   spec.add_runtime_dependency "xively-rb", "~> 0.2"
   spec.add_runtime_dependency "bigdecimal", "~> 1.2"
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: xively-rb-connector
 version: !ruby/object:Gem::Version
-  version: 0.1.3
+  version: 0.1.4
 platform: ruby
 authors:
 - Jordan Duggan
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-04-03 00:00:00.000000000 Z
+date: 2014-04-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -67,19 +67,19 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: log4r
+  name: logging
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: '1.1'
+        version: '1.8'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: '1.1'
+        version: '1.8'
 - !ruby/object:Gem::Dependency
   name: xively-rb
   requirement: !ruby/object:Gem::Requirement
@@ -133,7 +133,7 @@ files:
 - lib/xively-rb-connector/connection.rb
 - lib/xively-rb-connector/datastream.rb
 - lib/xively-rb-connector/device.rb
-- lib/xively-rb-connector/logging.rb
+- lib/xively-rb-connector/logger.rb
 - lib/xively-rb-connector/version.rb
 - spec/spec_helper.rb
 - spec/support/fixtures/feed_100000000.json

data/lib/xively-rb-connector/logging.rb

@@ -1,25 +0,0 @@
-require 'log4r'
-include Log4r
-module XivelyConnector
-
-  module Logging
-
-    def logger
-      @logger ||= XivelyConnector::Logging.logger
-    end
-
-    def self.logger
-      @logger ||= self.configure_logger_for(self.class.name)
-    end
-
-    def self.configure_logger_for(classname)
-      l = Logger.new(classname)
-      l.level = ERROR
-      l.trace = false
-      l.add Log4r::Outputter.stderr
-      l
-    end
-
-  end
-
-end