stocks 0.0.2 → 0.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: e8a32a3160735bcc269c2da3567553382d56c810
-  data.tar.gz: b443130a3470403e57cd9bad82688c6b915c1f70
+  metadata.gz: aaf935fa30015a7d522d988c453476978fd429df
+  data.tar.gz: 858b612f40c17f3144d633a06c41cdf0f479b899
 SHA512:
-  metadata.gz: 59f678bceefd7903c2444c1e452a67243668f7c0a8bbe3e2b6b2254b24b6e876a7c66fc2fc25ab5ba069d1806fd062e192d6ee841105a4db4b689126a2f8af37
-  data.tar.gz: 066a218fe46f8a47647945a37fa1f15ec33b577f90505558c63d4443eb1c6fb9e65c3c4cada46a0bd54fd6d2defa560cde2079464aff2a1d33682e574e7c5c3c
+  metadata.gz: 42cade0497d0503ce34492ccb85604c03a827e62ff4db6de63a5b3d570979b274dd00322eacce248970cbcca9a4338bb10d4167f76504e36122ac5f9cf26d70b
+  data.tar.gz: efbda82899547a538d324be44cb9824cf9b06f2aecbc262b039ed933d5fe3edd864d9a766cc00880f1b98b9b3473e3dd159867955817b83d776d201f2c8e9699

data/lib/stocks.rb

@@ -8,6 +8,7 @@ require 'yahoofinance'
 # Require all Stocks related files
 require 'stocks/errors'
 require 'stocks/historical'
+require 'stocks/quote'
 require 'stocks/validators/exists'
 
 # Provides an interface to do real-time analysis of stocks.
@@ -29,7 +30,6 @@ module Stocks
   # - +symbol+ The symbol to evaluate for existence
   # ===== *Raises*
   # - +RetrievalError+ If the provided symbol does not exist
-  # Whether or not the provided symbol exists
   def self.exists!(symbol)
     raise RetrievalError.new(symbol) if !Stocks.exists?(symbol)
   end
@@ -48,17 +48,29 @@ module Stocks
     last_trade
   end
 
-  private
+  # Fetches a quote for the provided symbol.
+  #
+  # ===== *Args*
+  # - +symbol+ The symbol to evaluate
+  # - +type+ The type of quote to retreive
+  # ===== *Returns*
+  # The quote for the provided symbol
+  # ===== *Raises*
+  # - +RetrievalError+ If the provided symbol does not exist
+  # - +UnsupportedError+ If the provided type is not supported
+  def self.quote(symbol, type = :standard)
+    raise UnsupportedError.new(type, Quote::TYPES.keys) if !Quote::TYPES.has_key?(type)
 
-  EXISTS_CACHE = LRUCache.new(max_size: 500, ttl: 1.month) # :nodoc:
+    symbol.upcase!
+    quote = YahooFinance.send(Quote::TYPES[type], symbol)[symbol]
+    raise RetrievalError.new(symbol) if quote.name == NOT_AVAILABLE
 
-  def self.quote(symbol, fields = [:lastTrade])
-    data = {}
-    standard_quote = YahooFinance::get_standard_quotes(symbol)[symbol]
-    fields.each do |field|
-      data[field] = standard_quote.send(field) rescue nil
-    end
-    data
+    Quote.new(quote)
   end
+
+  private
+
+  EXISTS_CACHE = LRUCache.new(max_size: 500, ttl: 1.month) # :nodoc:
+  NOT_AVAILABLE = 'N/A' # :nodoc:
 end
 

data/lib/stocks/errors.rb

@@ -4,7 +4,7 @@
 module Stocks
   # An error raised when data retrieval fails
   class RetrievalError < ArgumentError
-    def initialize(symbol) # :nodoc:
+    def initialize(symbol)
       super(self.class.message(symbol))
     end
 
@@ -25,7 +25,7 @@ module Stocks
 
   # An error raised when an unsupported value is provided
   class UnsupportedError < ArgumentError
-    def initialize(provided, supported) # :nodoc:
+    def initialize(provided, supported)
       super(self.class.message(provided, supported))
     end
 

data/lib/stocks/quote.rb

@@ -0,0 +1,30 @@
+# Author::    Matt Fornaciari (mailto:mattforni@gmail.com)
+# License::   MIT
+
+# Provides an instance of a stock quote.
+class Quote < Hash
+  # Mapping from base_quote type to YahooFinance method of retrieval
+  TYPES = {
+    'extended': :get_extended_quotes,
+    'standard': :get_standard_quotes
+  }
+
+  def initialize(base_quote)
+    @base_quote = base_quote
+    get_fields.each { |field| self[field] = base_quote.send(field) }
+  end
+
+  private
+
+  attr_accessor :base_quote
+
+  # :nodoc:
+  def get_fields
+    @base_quote.instance_variables.map { |f|
+      f.to_s.gsub('@','').to_sym
+    }.reject { |f_sym|
+      !@base_quote.public_methods.include?(f_sym)
+    }
+  end
+end
+

data/lib/stocks/validators.rb

@@ -1,6 +1,8 @@
 # Author::    Matt Fornaciari (mailto:mattforni@gmail.com)
 # License::   MIT
 
+require 'validators/exists'
+
 module Stocks
   # Provides an interface for validating ActiveRecord models.
   module Validators

data/lib/stocks/validators/exists.rb

@@ -1,6 +1,8 @@
 # Author::    Matt Fornaciari (mailto:mattforni@gmail.com)
 # License::   MIT
 
+require 'active_model'
+
 module Stocks
   module Validators
     # An ActiveRecord validator which validates that an attribute on a model is a
@@ -26,7 +28,7 @@ module Stocks
         ERROR_MESSAGE % symbol
       end
 
-      # Validates that a record have a valid symbol.
+      # Validates that a record has a valid symbol.
       #
       # ===== *Args*
       # - +record+ The record to validate

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: stocks
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.3
 platform: ruby
 authors:
 - Matthew Fornaciari
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-05-08 00:00:00.000000000 Z
+date: 2015-06-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -103,6 +103,7 @@ files:
 - lib/stocks.rb
 - lib/stocks/errors.rb
 - lib/stocks/historical.rb
+- lib/stocks/quote.rb
 - lib/stocks/validators.rb
 - lib/stocks/validators/exists.rb
 homepage: http://rubygems.org/gems/stocks