higo 0.0.2 → 0.0.8

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 97469ec0b1755c63561a9d6ce00050a887074baf
-  data.tar.gz: 4621abc05548852b449bbd54ca1a2522e6368e0f
+  metadata.gz: 95b8dff1c0539a5ed0d976717e5577f571739b41
+  data.tar.gz: 8b02d3084d8d4523007eb5c8c167047ffa86f5ac
 SHA512:
-  metadata.gz: 1f52d1347c109186ca7a1bea428662ae88272e4e5afbc573eecb5e7f37804743bdebf6633e54b441ed1fde09d10c43b0dfb99a921d85922a2c26b229c0bfc8c1
-  data.tar.gz: dbd6dcb639cd8cc2661f7780f661274e8bace6c1c8f27d96674f9a0d33a25f2a7f2fba50e26d8d9229483ea145c2409e2cdc7ee1c4f27ba2a172b530dd350e95
+  metadata.gz: 4b4d82731b6d25251f5f34b9b8a569dbaa8283bc98277c5b7f51f9e1a5d8fc39472badd103e9a97285c3cf3cd68fb2ce5c68beef18cb745b4e90e73a94002faa
+  data.tar.gz: abeb604d37fbe08b6fa7bd1fbf17afd07805f1d72bf00ae596e5805874f71f205ceda53801d47de89151f7701d653249fefa8891fb37d537555dc7adea21dbb6

data/README.md

@@ -49,7 +49,7 @@ want. Higo might not be right for you at this stage.
 
 * ~~Generate arbitrary configuration values~~
 * Improve support for subclasses that define `method_missing`
-* Add support for JSON files
+* ~~Add support for JSON files~~
 * ~~Read from an external source~~
 * Improve documentation
 

data/lib/higo.rb

@@ -23,15 +23,18 @@
 # See https://github.com/rhodee/higo for updates.
 #
 #
-# stdlib
-require 'pathname'
-require 'fiber'
-require 'uri'
-require 'net/https'
-require 'tempfile'
-
 module Higo
+  # stdlib
+  require 'pathname'
+  require 'fiber'
+  require 'uri'
+  require 'net/https'
+  require 'tempfile'
+  require 'json'
+
+  # modules
   autoload :Version,      'higo/version'
   autoload :Configurable, 'higo/configurable'
   autoload :Transport,    'higo/transport'
+  autoload :Error,        'higo/error'
 end

data/lib/higo/configurable.rb

@@ -36,9 +36,11 @@ module Higo
         values = if file =~ /http/
                   Transport::Web.transport(path: file).finish
                  elsif file =~ /.?(txt|json)/
-                  Transport::File.transport(path: file).finish
+                  resource = Transport::Generic.new(path: file).file
+                  resource.call
+                  resource.finish
                  else
-                  raise 'Unable to read this type of file'
+                  raise Error::UnreadableFile
                  end
         values.each do |key,value|
           self.class.__send__(:attr_accessor, key)

data/lib/higo/error.rb

@@ -0,0 +1,11 @@
+module Error
+  AbstractError = Class.new(StandardError) do
+    # define initialize
+    # helpful message
+  end
+
+  UnreachableResource      = Class.new(AbstractError)
+  UnreadableFile           = Class.new(AbstractError)
+  UndefinedTransportMethod = Class.new(AbstractError)
+  NoFileFound              = Class.new(AbstractError)
+end

data/lib/higo/transport.rb

@@ -1,6 +1,10 @@
 module Higo
   module Transport
-    autoload :File, 'higo/transport/file'
-    autoload :Web,  'higo/transport/web'
+    autoload :Web,        'higo/transport/web'
+    autoload :Processing, 'higo/transport/processing'
+    autoload :Abstract,   'higo/transport/abstract'
+    autoload :Generic,    'higo/transport/generic'
+    autoload :JSON,       'higo/transport/json'
+    autoload :Text,       'higo/transport/text'
   end
 end

data/lib/higo/transport/abstract.rb

@@ -0,0 +1,42 @@
+module Higo
+  module Transport
+    class Abstract
+      include Transport::Processing
+
+      attr_reader :path
+      attr_accessor :responses, :_raw_file
+
+      def initialize(path: nil)
+        @path      = find_file(path)
+        @_raw_file = {}
+        @responses = {}
+      end
+
+      # Convenience method for creating Higo::Transport objects and returning a Fiber
+      # containing the process for reading JSON or text files from a specified path
+      #
+      # @param [String]
+      # @return [Fiber]
+      def self.transport(path)
+        file  = new(path)
+        file._raw_file = file.call
+        file
+      end
+
+      # Placeholder method. Must be implemented in subclasses of Higo::Transport::Abstract
+      #
+      # @return [Fiber]
+      def call
+        raise Error::UndefinedTransportMethod
+      end
+
+      # Placeholder method. Must be implemented in subclasses of Higo::Transport::Abstract
+      #
+      # @return [Hash]
+      def finish
+        raise Error::UndefinedTransportMethod
+      end
+
+    end
+  end
+end

data/lib/higo/transport/generic.rb

@@ -0,0 +1,25 @@
+# Provide an interface to read file JSON or text files from a specified path
+#
+# @param [String]
+# @return [Higo::Transport::JSON, Higo::Transport::Text]
+module Higo
+  module Transport
+    class Generic
+      include Processing
+
+      attr_reader :file
+
+      def initialize(path: nil)
+        proxy = find_file(path)
+        case proxy.extname
+        when '.js'
+          @file = JSON.new(path: proxy.to_s)
+        when '.json'
+          @file = JSON.new(path: proxy.to_s)
+        when '.txt'
+          @file = Text.new(path: proxy.to_s)
+        end
+      end
+    end
+  end
+end

data/lib/higo/transport/json.rb

@@ -0,0 +1,32 @@
+# Provide an interface to read JSON files from a specified path and return a Ruby hashes of each key value pair
+module Higo
+  module Transport
+    class JSON < Abstract
+
+      def initialize(*)
+        super
+        @_raw_file = call
+      end
+
+      # Reads file from path provided by Higo::Transport::Abstract
+      #
+      # @return [Fiber]
+      def call
+        Fiber.new do
+          ::File.open(path, 'r') do |f|
+            f.read
+          end
+        end
+      end
+
+      # Provide an interface to read JSON files from a specified path and thurn them into Ruby hashes
+      #
+      # @return [Hash]
+      def finish
+        data = _raw_file.resume
+        responses.merge!(process_value(data))
+      end
+    end
+  end
+end
+

data/lib/higo/transport/processing.rb

@@ -0,0 +1,39 @@
+# Provide helper methods to return String or Hash objects used in process Higo::Transport objects
+module Higo
+  module Transport
+    module Processing
+
+      private
+      # Provides a string if text or Hash if JSON format detected
+      #
+      # @private
+      # @param [String]
+      # @return [String, Hash]
+      def process_value(str, delimeter='=')
+
+        file_type = path.extname.tr('.','')
+        if file_type == 'txt'
+          str.tr('\'','').chomp.split(delimeter)
+        elsif file_type == 'json' || file_type == 'js'
+          ::JSON.parse(str)
+        end
+      end
+
+      # Makes attempt to find file in relative and absolute paths
+      #
+      # @private
+      # @return [Hash]
+      def find_file(path)
+        path_to_file = Pathname.new(path)
+
+        if path_to_file.file?
+          return path_to_file
+        elsif path_to_file.relative? && path_to_file.expand_path.file?
+          return path_to_file
+        else
+          raise Error::NoFileFound
+        end
+      end
+    end
+  end
+end

data/lib/higo/transport/text.rb

@@ -0,0 +1,34 @@
+# Provide an interface to read text files from a specified path and return a Ruby hashes of each key value pair
+module Higo
+  module Transport
+    class Text < Abstract
+
+      def initialize(*)
+        super
+        @_raw_file = call
+      end
+
+      # Reads file from path provided by Higo::Transport::Abstract
+      #
+      # @return [Fiber]
+      def call
+        Fiber.new do
+          ::File.open(path, 'r') do |f|
+            f.readlines.map
+          end
+        end
+      end
+
+      # Returns a Hash object based on the key value provided per line
+      #
+      # @return [Hash]
+      def finish
+        _raw_file.resume.map do |val|
+          responses.merge!(Hash[*process_value(val)])
+        end
+        responses
+      end
+    end
+  end
+end
+

data/lib/higo/transport/web.rb

@@ -27,20 +27,20 @@ module Higo
 
       def finish(data=nil)
         result = data.respond_to?(:resume) ? data.resume : self._raw_data.resume
-        raise 'Provide an object that responds to resume' if data.nil?
+        raise Error::UnreachableResource if bad_request?(result.code) or server_unavailable?(result.code)
         temp_file = Tempfile.new([self.path.host.tr('.',''), ::Pathname.new(self.path.to_s).extname])
 
         if success?(result.code) && result.body.bytesize > 0
           ::File.open(temp_file.path, 'w') { |f| f.write(result.body) }
-          response = Transport::File.transport(path: temp_file.path).finish
+          result = Transport::Generic.new(path: temp_file.path).file.finish
           temp_file.unlink
         else
-          raise 'No Data at endpoint'
+          raise Error::UnreachableResource
         end
 
-        response
+        result
       rescue => e
-        raise e if e.class == SocketError
+        raise e if e.class == Error::UnreachableResource
       end
 
       private

data/lib/higo/version.rb

@@ -2,7 +2,7 @@ module Higo
     module Version
       Major = 0
       Minor = 0
-      Tiny  = 2
+      Tiny  = 8
       Pre   = nil
 
       String = [Major, Minor, Tiny, Pre].compact.join(".")

data/test/test_generic_transport.rb

@@ -0,0 +1,20 @@
+require_relative './test_helper'
+require 'higo/transport/generic'
+
+class TestGenericTransport < Higo::TestCase
+  def test_text_fetch
+    resource = Higo::Transport::Generic.new(path: 'test/support/config_values.txt')
+    assert_instance_of Higo::Transport::Text, resource.file
+  end
+
+  def test_json_fetch
+    resource = Higo::Transport::Generic.new(path: 'test/support/config_values.json')
+    assert_instance_of Higo::Transport::JSON, resource.file
+  end
+
+  def test_js_fetch
+    resource = Higo::Transport::Generic.new(path: 'test/support/config_values.js')
+    assert_instance_of Higo::Transport::JSON, resource.file
+  end
+end
+

data/test/test_helper.rb

@@ -8,6 +8,8 @@ require 'minitest/pride'
 
 module Higo
   class TestCase < Minitest::Test
+    require 'higo/error'
+
     StubResponse = Struct.new(:code, :body)
   end
 end

data/test/test_json_transport.rb

@@ -0,0 +1,18 @@
+require_relative './test_helper'
+require 'higo/transport/json'
+
+class TestJSONTransport < Higo::TestCase
+  def test_file_path
+    resource = Higo::Transport::JSON.new(path: 'test/support/config_values.json')
+    assert_instance_of Pathname, resource.path
+  end
+
+  def test_file_path_error
+    assert_raises(Error::NoFileFound) { Higo::Transport::JSON.new(path: 'test/support/no_file_here.jsun') }
+  end
+
+  def test_txt_file_read
+    results = Higo::Transport::JSON.transport(path: 'test/support/config_values.json').finish
+    refute_equal true, results.empty?
+  end
+end

data/test/test_text_transport.rb

@@ -0,0 +1,18 @@
+require_relative './test_helper'
+require 'higo/transport/text'
+
+class TestFileTransport < Higo::TestCase
+  def test_file_path
+    resource = Higo::Transport::Text.new(path: 'test/support/config_values.txt')
+    assert_instance_of Pathname, resource.path
+  end
+
+  def test_file_path_error
+    assert_raises(Error::NoFileFound) { Higo::Transport::Text.new(path: 'test/support/no_file_here.txt') }
+  end
+
+  def test_txt_file_read
+    results = Higo::Transport::Text.transport(path: 'test/support/config_values.txt').finish
+    refute_equal true, results.empty?
+  end
+end

data/test/test_web_transport.rb

@@ -7,13 +7,13 @@ class TestWebTransport < Higo::TestCase
   end
 
   def test_resource_path_error
-    assert_raises(SocketError) { Higo::Transport::Web.transport(path: 'http://www.notaresource.comz').finish }
+    assert_raises(Error::UnreachableResource) { Higo::Transport::Web.transport(path: 'http://www.notaresource.comz').finish }
   end
 
   def test_file_read
-    url             = 'https://secret.configuration.com/plain_config.txt'
-    request         = Higo::Transport::Web.new(path: url)
-    rsp = StubResponse.new(200, "user=foo\njoy='code'")
+    url     = 'https://secret.configuration.com/plain_config.txt'
+    request = Higo::Transport::Web.transport(path: url)
+    rsp     = StubResponse.new(200, "user=foo\njoy='code'")
     payload = Fiber.new { rsp }
 
     refute_equal true, request.finish(payload).empty?

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: higo
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.8
 platform: ruby
 authors:
 - rhodee
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-03-25 00:00:00.000000000 Z
+date: 2014-03-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: yard
@@ -134,15 +134,22 @@ files:
 - higo.gemspec
 - lib/higo.rb
 - lib/higo/configurable.rb
+- lib/higo/error.rb
 - lib/higo/transport.rb
-- lib/higo/transport/file.rb
+- lib/higo/transport/abstract.rb
+- lib/higo/transport/generic.rb
+- lib/higo/transport/json.rb
+- lib/higo/transport/processing.rb
+- lib/higo/transport/text.rb
 - lib/higo/transport/web.rb
 - lib/higo/version.rb
 - test/test_configurable.rb
-- test/test_file_transport.rb
+- test/test_generic_transport.rb
 - test/test_helper.rb
 - test/test_higo_included.rb
 - test/test_higo_subclass.rb
+- test/test_json_transport.rb
+- test/test_text_transport.rb
 - test/test_web_transport.rb
 homepage: https://github.com/rhodee/higo
 licenses:
@@ -164,7 +171,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.2.0
+rubygems_version: 2.2.2
 signing_key: 
 specification_version: 4
 summary: A dyanmic configuration object creator. Reads from local files, remote resources

data/lib/higo/transport/file.rb

@@ -1,55 +0,0 @@
-module Higo
-  module Transport
-    class File
-
-      attr_reader :path
-      attr_accessor :responses, :_raw_file
-
-      def initialize(path: nil)
-        @path      = find_file(path)
-        @_raw_file = {}
-        @responses = {}
-      end
-
-      def self.transport(path)
-        file  = new(path)
-        file._raw_file = file.call
-        file
-      end
-
-      def call
-        Fiber.new do
-          ::File.open(path, 'r') do |f|
-            f.readlines.map
-          end
-        end
-      end
-
-      def finish
-        _raw_file.resume.map do |val|
-          responses.merge!(Hash[*process_value(val)])
-        end
-        responses
-      end
-
-      private
-        def process_value(str, delimeter='=')
-          if path.extname.tr('.','') == 'txt'
-            str.tr('\'','').chomp.split(delimeter)
-          end
-        end
-
-        def find_file(path)
-          path_to_file = Pathname.new(path)
-
-          if path_to_file.file?
-            return path_to_file
-          elsif path_to_file.relative? && path_to_file.expand_path.file?
-            return path_to_file
-          else
-            raise 'Unable to find file at location'
-          end
-        end
-    end
-  end
-end

data/test/test_file_transport.rb

@@ -1,18 +0,0 @@
-require_relative './test_helper'
-require 'higo/transport/file'
-
-class TestFileTransport < Higo::TestCase
-  def test_file_path
-    resource = Higo::Transport::File.new(path: 'test/support/config_values.txt')
-    assert_instance_of Pathname, resource.path
-  end
-
-  def test_file_path_error
-    assert_raises(RuntimeError) { Higo::Transport::File.new(path: 'test/support/no_file_here.txt') }
-  end
-
-  def test_file_read
-    results = Higo::Transport::File.transport(path: 'test/support/config_values.txt').finish
-    refute_equal true, results.empty?
-  end
-end