stocktastic 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 0644c3d920263dfb868b56c6ba8871ade3f6be41
+  data.tar.gz: 45c0a5bb26eff0ea4b1814cb5d1cf7472b46b06e
+SHA512:
+  metadata.gz: 228c47bb333d6b5d86dcb7e1637f2f33945f38303483aa0de5e6774ebf1f8f12b8cec4856a91f04a0650b46a12a11bf6c693d5341e593240f1dd4fc85e0a0eee
+  data.tar.gz: f2f32650cf61d047cebbca58282f2d8a374cc248aa256a0cd01f6af784b4c6f2f0d95bb04bb028e37c9a71109da959f934873bc9e4e0f12f0ae091897ecec7c3

data/.autotest

@@ -0,0 +1,25 @@
+# -*- ruby -*-
+
+require "autotest/restart"
+
+# Autotest.add_hook :initialize do |at|
+#   at.testlib = "minitest/unit"
+#
+#   at.extra_files << "../some/external/dependency.rb"
+#
+#   at.libs << ":../some/external"
+#
+#   at.add_exception "vendor"
+#
+#   at.add_mapping(/dependency.rb/) do |f, _|
+#     at.files_matching(/test_.*rb$/)
+#   end
+#
+#   %w(TestA TestB).each do |klass|
+#     at.extra_class_map[klass] = "test/test_misc.rb"
+#   end
+# end
+
+# Autotest.add_hook :run_command do |at|
+#   system "rake build"
+# end

data/History.rdoc

@@ -0,0 +1,18 @@
+=== 0.1.0 / 2014-08-16
+
+* Added Stocktastic::Base for main Stocktastic usage.
+  It uses the Yahoo adapter by default and can fetch quote
+  details for a single symbol or a list of symbols.
+
+      stocktastic = Stocktastic::Base.new
+      quote = stocktastic.quote 'AAPL'
+      quotes = stocktastic.quotes ['AAPL', 'MSFT']
+
+* Added Yahoo adapter which can fetch quotes from Yahoo Finance
+
+=== 0.0.1 / 2014-08-15
+
+* 1 minor enhancement
+
+  * Birthday!
+

data/Manifest.txt

@@ -0,0 +1,12 @@
+.autotest
+History.rdoc
+Manifest.txt
+README.rdoc
+Rakefile
+bin/stocktastic
+lib/stocktastic.rb
+lib/stocktastic/base.rb
+lib/stocktastic/adapter.rb
+lib/stocktastic/adapter/base.rb
+lib/stocktastic/adapter/yahoo.rb
+test/test_stocktastic.rb

data/README.rdoc

@@ -0,0 +1,66 @@
+= stocktastic
+
+* https://github.com/pubis/stocktastic
+
+== Description
+
+Stocktastic fetches stock quotes
+
+It uses Yahoo Finance as a source by default.
+
+== Usage
+
+=== Basics
+
+    require 'stocktastic'
+
+    stocktastic = Stocktastic::Base.new
+    # => #<Stocktastic::Base @adapter=#<Stocktastic::Adapter::Yahoo>>
+
+    quote = stocktastic.quote 'AAPL'
+    # => {:symbol=>"AAPL", :name=>"Apple Inc.", :last_trade_price_only=>"97.98", ...}
+
+    qoutes = stocktastic.quotes ['AAPL', 'GOOG', 'MSFT']
+    # => [{:symbol=>"AAPL", :name=>"Apple Inc.", ...}, {:symbol=>"GOOG", ...}, ...]
+
+    # Searching is not implemented yet
+    #stocks = stocktastic.search 'Google'
+    # => [{:symbol => 'GOOG', :name => 'Google'}, ...]
+
+    # History is not implemented yet
+    #last_month = Date.today.prev_month..Date.today
+    #history = stocktastic.history 'AAPL', last__month
+    # => [{:date=>"2014-08-16", :close=>"97.98"}, ...]
+
+== Requirements
+
+* Ruby 1.9 or greater
+
+== Installation
+
+    gem install stocktastic
+
+== License
+
+(The MIT License)
+
+Copyright (c) 2014 Jonas Lundqvist
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+'Software'), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
+IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
+CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
+TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
+SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/Rakefile

@@ -0,0 +1,16 @@
+# -*- ruby -*-
+
+require "rubygems"
+require "hoe"
+
+Hoe.plugin :minitest
+Hoe.plugin :rcov
+Hoe.plugin :rdoc
+
+Hoe.spec "stocktastic" do
+  developer("Jonas Lundqvist", "lundqvist.j@gmail.com")
+
+  license "MIT"
+end
+
+# vim: syntax=ruby

data/bin/stocktastic

@@ -0,0 +1,3 @@
+#!/usr/bin/env ruby
+
+abort "you need to write me"

data/lib/stocktastic.rb

@@ -0,0 +1,13 @@
+require 'stocktastic/adapter'
+require 'stocktastic/base'
+
+module Stocktastic
+  # The version of Stocktastic
+  VERSION = "0.1.0"
+
+  ##
+  # Default adapter through which quotes are fetched.
+  def self.default_adapter
+    Stocktastic::Adapter::Yahoo
+  end
+end

data/lib/stocktastic/adapter.rb

@@ -0,0 +1,7 @@
+require 'stocktastic/adapter/base'
+require 'stocktastic/adapter/yahoo'
+
+module Stocktastic
+  module Adapter #:nodoc:
+  end
+end

data/lib/stocktastic/adapter/base.rb

@@ -0,0 +1,7 @@
+module Stocktastic
+  module Adapter
+    # Abstract base class for adapters
+    class Base
+    end
+  end
+end

data/lib/stocktastic/adapter/yahoo.rb

@@ -0,0 +1,68 @@
+require 'net/http'
+require 'csv'
+
+module Stocktastic
+  module Adapter
+    ##
+    # Adapter for interfacing with Yahoo finance
+    class Yahoo < Base
+      # Uri used for fetching quotes
+      QUOTES_URI = "http://download.finance.yahoo.com/d/quotes.csv"
+
+      ##
+      # List of available paramters
+      # This list is used as a single source of reference for
+      # a) mapping between requested parameters and url parameters
+      # and b) mapping between the result array and hash keys.
+      PARAMETER_MAP = {
+        symbol:                's',
+        name:                  'n',
+        last_trade_price_only: 'l1',
+        last_trade_date:       'd1',
+        last_trade_time:       't1'
+      }
+
+      ##
+      # Fetches quote details for a single symbol.
+      # Last argument can specify options:
+      # - :parameters Array of parameters to get (default is everything)
+      def get_single_quote symbol, options = {}
+        get_multiple_quotes([symbol], options)[0]
+      end
+
+      # Fetches quote details for multiple symbols.
+      # Last argument can specify options:
+      # - :parameters Array of parameters to get (default is everything)
+      def get_multiple_quotes symbols, options = {}
+        options[:parameters] ||= PARAMETER_MAP.keys
+        get_quotes symbols, options[:parameters]
+      end
+
+      private
+
+      def get_quotes symbols, parameters
+         response = get_response(uri(symbols, parameters))
+         map_result parse(response.body), parameters
+      end
+
+      def get_response uri
+        Net::HTTP.get_response(uri)
+      end
+
+      def map_result result, parameters
+        result.map {|q| parameters.zip(q).to_h }
+      end
+
+      def parse text
+        CSV.parse text
+      end
+
+      def uri symbols, parameters
+        symbols = symbols.join '+'
+        parameters = PARAMETER_MAP.values_at(*parameters).join
+
+        URI.parse "#{QUOTES_URI}?s=#{symbols}&f=#{parameters}"
+      end
+    end
+  end
+end

data/lib/stocktastic/base.rb

@@ -0,0 +1,41 @@
+module Stocktastic #:nodoc:
+
+  # Main class for integrating with Stocktastic.
+  #
+  #   stocktastic = Stocktastic::Base.new
+  #   quote = stocktastic.quote('AAPL')
+  class Base
+    ##
+    # Returns the adapter currently in use
+    attr_reader :adapter
+
+    ##
+    # :call-seq:
+    #     Stocktastic::Base.new
+    #     Stocktastic::Base.new(CustomAdapter.new)
+    #
+    # Construct a new Stocktastic::Base object using the specified +adapter+.
+    # If no +adapter+ is passed the +default_adapter+ will be used.
+    def initialize adapter = Stocktastic::default_adapter.new
+      @adapter = adapter
+    end
+
+    ##
+    # Fetch quote information for a single symbol.
+    #
+    #     quote = stocktastic.quote('AAPL')
+    #     # => {:symbol => 'AAPL', :name => 'Apple Inc.', ...}
+    def quote symbol
+      adapter.get_single_quote symbol
+    end
+
+    ##
+    # Fetch quote information for many symbols.
+    #
+    #     quotes = stocktastic.quotes(['AAPL', 'GOOG'])
+    #     # => [{:symbol => 'AAPL', :name => 'Apple Inc.', ...}, {:symbol => 'GOOG', ...}]
+    def quotes symbols
+      adapter.get_multiple_quotes symbols
+    end
+  end
+end

data/test/integration/test_quotes.rb

@@ -0,0 +1,22 @@
+require 'minitest/autorun'
+require 'stocktastic'
+
+describe "Fetch quotes" do
+  describe "using default (Yahoo) adapter" do
+    before do
+      @stocktastic = Stocktastic::Base.new
+    end
+
+    it "fetches a single quote" do
+      quote = @stocktastic.quote('AAPL')
+      quote[:symbol].must_equal 'AAPL'
+    end
+
+    it "fetches multiple quotes" do
+      symbols = ['AAPL', 'MSFT', 'GOOG']
+      quotes = @stocktastic.quotes(symbols)
+      quotes.size.must_equal 3
+      quotes.map {|q| q[:symbol] }.must_equal symbols
+    end
+  end
+end

data/test/stocktastic/adapter/test_base.rb

@@ -0,0 +1,5 @@
+require 'minitest/autorun'
+require 'stocktastic'
+
+describe Stocktastic::Adapter::Base, "abstract functions" do
+end

data/test/stocktastic/adapter/test_yahoo.rb

@@ -0,0 +1,80 @@
+require 'minitest/autorun'
+require 'stocktastic'
+
+describe Stocktastic::Adapter::Yahoo do
+  before do
+    @adapter = Stocktastic::Adapter::Yahoo.new
+  end
+
+  it "inherits from base adapter" do
+    @adapter.must_be_kind_of Stocktastic::Adapter::Base
+  end
+
+  describe "Parameter Map" do
+    it "starts with :symbol" do
+      map = Stocktastic::Adapter::Yahoo::PARAMETER_MAP
+      map.keys[0].must_equal :symbol
+      map[:symbol].must_equal 's'
+    end
+  end
+
+  describe "get_single_quote" do
+    describe "without options" do
+      it "returns quote for a single symbol" do
+        quote = @adapter.get_single_quote 'AAPL'
+        quote[:symbol].must_equal 'AAPL'
+      end
+
+      it "gets everything by default" do
+        quote = @adapter.get_single_quote 'AAPL'
+        map = Stocktastic::Adapter::Yahoo::PARAMETER_MAP
+        map.keys.each do |k|
+          quote[k].wont_be_empty
+        end
+      end
+    end
+
+    describe "with custom parameters" do
+      it "accepts custom parameters through options" do
+        params = [:symbol, :last_trade_price_only, :name]
+        quote = @adapter.get_single_quote 'AAPL', parameters: params
+        quote[:symbol].must_equal 'AAPL'
+        params.each do |p|
+          quote[p].wont_be_empty
+        end
+      end
+    end
+  end
+
+  describe "get_multiple_quotes" do
+    describe "without options" do
+      it "returns quotes for an array of symbols" do
+        quotes = @adapter.get_multiple_quotes ['AAPL', 'GOOG', 'MSFT']
+        quotes.size.must_equal 3
+        quotes.map {|q| q[:symbol]}.must_equal ['AAPL', 'GOOG', 'MSFT']
+      end
+
+      it "gets everything by default" do
+        quotes = @adapter.get_multiple_quotes ['AAPL', 'GOOG']
+        map = Stocktastic::Adapter::Yahoo::PARAMETER_MAP
+        2.times do |n|
+          map.keys.each do |k|
+            quotes[n][k].wont_be_empty
+          end
+        end
+      end
+    end
+
+    describe "with custom parameters" do
+      it "accepts custom parameters through options" do
+        params = [:symbol, :last_trade_price_only, :name]
+        quotes = @adapter.get_multiple_quotes ['AAPL', 'GOOG'], parameters: params
+        2.times do |n|
+          params.each do |p|
+            quotes[n][p].wont_be_empty
+          end
+        end
+      end
+    end
+  end
+end

data/test/stocktastic/test_base.rb

@@ -0,0 +1,38 @@
+require 'minitest/autorun'
+require 'minitest/mock'
+require 'stocktastic'
+
+describe Stocktastic::Base do
+  describe "#adapter" do
+    it "can be set when created" do
+      adapter = Object.new
+      Stocktastic::Base.new(adapter).adapter.must_equal adapter
+    end
+
+    it "uses the default adapter" do
+      Stocktastic::Base.new.adapter.must_be_instance_of Stocktastic::default_adapter
+    end
+  end
+
+  describe "#quote" do
+    it "delegates to adapter#get_single_quote" do
+      adapter = MiniTest::Mock.new
+      adapter.expect(:get_single_quote, nil, ['SYM'])
+      stocktastic = Stocktastic::Base.new(adapter)
+
+      stocktastic.quote('SYM')
+      adapter.verify
+    end
+  end
+
+  describe "#quotes" do
+    it "delegates to adapter#get_multiple_quotes" do
+      adapter = MiniTest::Mock.new
+      adapter.expect(:get_multiple_quotes, nil, [['SYM1', 'SYM2']])
+      stocktastic = Stocktastic::Base.new(adapter)
+
+      stocktastic.quotes(['SYM1', 'SYM2'])
+      adapter.verify
+    end
+  end
+end

data/test/test_stocktastic.rb

@@ -0,0 +1,14 @@
+require "minitest/autorun"
+require "stocktastic"
+
+describe Stocktastic do
+  it "has a version" do
+    Stocktastic::VERSION.must_be_instance_of String
+  end
+
+  describe "default_adapter" do
+    it "returns Yahoo adapter" do
+      Stocktastic::default_adapter.must_equal Stocktastic::Adapter::Yahoo
+    end
+  end
+end

metadata

@@ -0,0 +1,131 @@
+--- !ruby/object:Gem::Specification
+name: stocktastic
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Jonas Lundqvist
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-08-16 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.4'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.4'
+- !ruby/object:Gem::Dependency
+  name: rdoc
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+- !ruby/object:Gem::Dependency
+  name: rcov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
+- !ruby/object:Gem::Dependency
+  name: hoe
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.12'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.12'
+description: |-
+  Stocktastic fetches stock quotes
+
+  It uses Yahoo Finance as a source by default.
+email:
+- lundqvist.j@gmail.com
+executables:
+- stocktastic
+extensions: []
+extra_rdoc_files:
+- History.rdoc
+- Manifest.txt
+- README.rdoc
+files:
+- ".autotest"
+- ".gemtest"
+- History.rdoc
+- Manifest.txt
+- README.rdoc
+- Rakefile
+- bin/stocktastic
+- lib/stocktastic.rb
+- lib/stocktastic/adapter.rb
+- lib/stocktastic/adapter/base.rb
+- lib/stocktastic/adapter/yahoo.rb
+- lib/stocktastic/base.rb
+- test/integration/test_quotes.rb
+- test/stocktastic/adapter/test_base.rb
+- test/stocktastic/adapter/test_yahoo.rb
+- test/stocktastic/test_base.rb
+- test/test_stocktastic.rb
+homepage: https://github.com/pubis/stocktastic
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options:
+- "--main"
+- README.rdoc
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.2.2
+signing_key: 
+specification_version: 4
+summary: Stocktastic fetches stock quotes  It uses Yahoo Finance as a source by default.
+test_files:
+- test/stocktastic/test_base.rb
+- test/stocktastic/adapter/test_base.rb
+- test/stocktastic/adapter/test_yahoo.rb
+- test/test_stocktastic.rb
+- test/integration/test_quotes.rb