eod_data 0.2.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 3ef51eae22119172e8e9e2b4559601bff4e3d2be
+  data.tar.gz: 20607e6d872aee0e4405c2977700a65c75ef57dc
+SHA512:
+  metadata.gz: 34f9c4660ef83922bd85dfe0492985bdcfd0c50f39b4b9695da323c900d0a026e0251886ee0a6624ecb08195288cc483ba355e8307bd7df55e984393d4cce35b
+  data.tar.gz: f321b0f6b461c368128418108f7ecd73ae296b5dace6e8dd8898160a376d9be32402cd297afea2a5eb592a02f254309906fb0e1de10d1f2c58dec013faeecb06

data/.gitignore

@@ -0,0 +1,14 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log

data/.rspec

@@ -0,0 +1,3 @@
+--color
+--warnings
+--require spec_helper

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in eod_data.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Roy Ratcliffe
+
+MIT License
+
+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
+NON-INFRINGEMENT. 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/README.md

@@ -0,0 +1,31 @@
+# EodData
+
+TODO: Write a gem description
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'eod_data'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install eod_data
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Contributing
+
+1. Fork it ( https://github.com/[my-github-username]/eod_data/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request

data/Rakefile

@@ -0,0 +1,5 @@
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new('spec')
+task default: :spec

data/eod_data.gemspec

@@ -0,0 +1,27 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'eod_data/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'eod_data'
+  spec.version       = EodData::VERSION
+  spec.authors       = ['Roy Ratcliffe']
+  spec.email         = ['roy@pioneeringsoftware.co.uk']
+  spec.summary       = %q{}
+  spec.description   = %q{}
+  spec.homepage      = ''
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ['lib']
+
+  spec.add_runtime_dependency 'nokogiri'
+  spec.add_runtime_dependency 'activesupport'
+  spec.add_development_dependency 'bundler'
+  spec.add_development_dependency 'rake'
+  spec.add_development_dependency 'rspec'
+  spec.add_development_dependency 'teamcity-ruby-client'
+end

data/lib/eod_data.rb

@@ -0,0 +1,5 @@
+require 'eod_data/version'
+require 'eod_data/web_service'
+
+module EodData
+end

data/lib/eod_data/version.rb

@@ -0,0 +1,3 @@
+module EodData
+  VERSION = '0.2.0'
+end

data/lib/eod_data/web_error.rb

@@ -0,0 +1,3 @@
+module EodData
+  class WebError < StandardError; end
+end

data/lib/eod_data/web_response.rb

@@ -0,0 +1,53 @@
+require 'active_support/core_ext/string'
+
+module EodData
+  # Represents an XML response from EODData, encapsulates the XML root element.
+  class WebResponse
+    attr_writer :root
+
+    # The XML root element should have the name RESPONSE or LOGINRESPONSE, or
+    # for that matter anything ending with RESPONSE. LOGINRESPONSE applies to
+    # token-access responses.
+    def initialize(root)
+      raise WebError, "Invalid response name #{root.name}" unless root.name.end_with?('RESPONSE')
+      @root = root
+    end
+
+    def name
+      @root.name
+    end
+
+    # Collects elements at +path+ whose element name matches +name+; where the
+    # name defaults to the path in singular, e.g. path at ITEMS, collecting
+    # elements by name ITEM. The answer is an array of hashes.
+    def elements_at(path, name=path.singularize)
+      @root.at(path).elements.select do |element|
+        element.name == name
+      end.map do |element|
+        hash = {}
+        element.attribute_nodes.each do |attr|
+          hash[attr.name.underscore.to_sym] = attr.content
+        end
+        hash
+      end
+    end
+
+    def respond_to?(symbol)
+      return true if symbol.to_s.end_with?('_string')
+      return true if symbol.to_s.end_with?('_text')
+      return true if symbol.to_s.end_with?('s')
+      super
+    end
+
+    private
+
+    # Sending method +something_string+ looks for attribute +something+ and
+    # answers its value.
+    def method_missing(symbol, *args)
+      return @root.attribute(symbol.to_s.sub(/_string$/, '').capitalize).to_s if symbol.to_s.end_with?('_string')
+      return @root.at(symbol.to_s.sub(/_text$/, '').upcase).text if symbol.to_s.end_with?('_text')
+      return elements_at(symbol.to_s.sub(/_/, '').upcase) if symbol.to_s.end_with?('s')
+      super
+    end
+  end
+end

data/lib/eod_data/web_service.rb

@@ -0,0 +1,220 @@
+require 'net/https'
+require 'uri'
+require 'nokogiri'
+
+require 'eod_data/web_response'
+require 'eod_data/web_error'
+
+class Hash
+  def convert_string_values!(type_and_keys = {})
+    type_and_keys.each do |type, keys|
+      keys.each do |key|
+        value = fetch(key)
+        case value
+          when String
+            store(key, case type
+                         when :date_time
+                           DateTime.parse(value)
+                         when :integer
+                           value.to_i
+                         when :boolean
+                           value.casecmp('true') == 0 || value.casecmp('yes') == 0
+                         else
+                           value
+                       end)
+        end
+      end
+    end
+    self
+  end
+end
+
+module EodData
+  class WebService
+    URI_BASE = 'http://ws.eoddata.com/data.asmx/'
+
+    def membership
+      post_with_token('Membership', &raise_block_unless_success).membership_text
+    end
+
+    # Answers the number of months of history that EODData authorises for the
+    # user to download. Use the following block of Ruby code to collect the
+    # number of authorised months for all the available exchanges, where
+    # +service+ is an EodData::WebService instance.
+    #
+    #   service.exchange_list.collect do |exchange|
+    #     exchange[:code]
+    #   end.collect do |code|
+    #     service.exchange_months(code)
+    #   end
+    #
+    def exchange_months(exchange)
+      post_with_token('ExchangeMonths',
+                      {
+                        'Exchange' => exchange
+                      },
+                      &raise_block_unless_success).months_text.to_i
+    end
+
+    # Answers an array of exchanges represented as hashes. Each hash has the
+    # following symbol keys, with their values automatically converted to
+    # appropriate types: date-times, integers and booleans.
+    #
+    #   :code
+    #   :name
+    #   :last_trade_date_time
+    #   :country
+    #   :currency
+    #   :advances
+    #   :declines
+    #   :suffix
+    #   :time_zone
+    #   :is_intraday
+    #   :intraday_start_date
+    #   :has_intraday_product
+    #
+    def exchange_list
+      post_with_token('ExchangeList', &raise_block_unless_success).exchanges.map do |exchange|
+        exchange.convert_string_values!(
+          date_time: %w(last_trade_date_time intraday_start_date).map(&:to_sym),
+          integer: %w(advances declines).map(&:to_sym),
+          boolean: %w(is_intraday has_intraday_product).map(&:to_sym),
+        )
+      end
+    end
+
+    def symbol_list(exchange)
+      post_with_token('SymbolList',
+                      {
+                        'Exchange' => exchange
+                      },
+                      &raise_block_unless_success).symbols.map do |symbol|
+        symbol.convert_string_values!(
+          date_time: %w(date_time).map(&:to_sym)
+        )
+      end
+    end
+
+    # Symbol changes have keys:
+    #
+    #   :date_time
+    #   :old_symbol
+    #   :new_symbol
+    #   :exchange_code
+    #   :new_exchange_code
+    #
+    def symbol_changes_by_exchange(exchange)
+      post_with_token('SymbolChangesByExchange',
+                      {
+                        'Exchange' => exchange
+                      },
+                      &raise_block_unless_success).symbol_changes
+    end
+
+    # Answers end-of-day quotes either for an entire exchange or for a given
+    # list of symbols at a given exchange. Answers an array of hashes, each
+    # representing an individual quote with keys as follows.
+    #
+    #   :symbol
+    #   :description
+    #   :name
+    #   :date_time
+    #   :open
+    #   :high
+    #   :low
+    #   :close
+    #   :volume
+    #   :open_interest
+    #   :previous
+    #   :change
+    #   :bid
+    #   :ask
+    #   :previous_close
+    #   :next_open
+    #   :modified
+    #
+    def quote_list(exchange, symbols=nil)
+      uri_path = 'QuoteList'
+      params = {'Exchange' => exchange}
+      symbols = [] if symbols.nil?
+      unless symbols.empty?
+        uri_path << '2'
+        params['Symbols'] = symbols.join(',')
+      end
+      post_with_token(uri_path, params, &raise_block_unless_success).quotes
+    end
+
+    def quote_list_by_date(exchange, date)
+      post_with_token('QuoteListByDate',
+                      {
+                        'Exchange' => exchange,
+                        'QuoteDate' => date.strftime('%Y%m%d')
+                      },
+                      &raise_block_unless_success).quotes
+    end
+
+    # Expects the environment to define a user name and password for use with
+    # the EODData API. However, when running within a Rails application, login
+    # first checks for an eod_data.yml configuration file in your Rails +config+
+    # folder; loading the user name and password from it if the file exists.
+    def login
+      if defined?(Rails)
+        path = File.join(Rails.configuration.paths['config'].expanded[0], 'eod_data.yml')
+        if File.exist?(path)
+          hash = YAML.load(File.open(path))
+          username = hash['username']
+          password = hash['password']
+        end
+      end
+      username ||= ENV['EODDATA_USERNAME']
+      password ||= ENV['EODDATA_PASSWORD']
+      post('Login',
+           'Username' => username,
+           'Password' => password) do |response|
+        raise WebError, "Invalid login response #{response.name}" unless response.name == 'LOGINRESPONSE'
+      end.token_string
+    end
+
+    # Answers the current EODData authentication token or obtains a new token.
+    def token
+      @token ||= login
+    end
+
+    # Sends an authenticated POST request to EODData web services. Answers an
+    # XML root element encapsulated by a WebResponse object if successful.
+    def post_with_token(uri_path, params={})
+      post(uri_path, params.merge({'Token' => token}))
+    end
+
+    # Sends a POST request to EODData. Answers a WebResponse object
+    # encapsulating the XML root element taken from the response body. This
+    # assumes that the body contains XML. Raises an exception if the HTML
+    # response code is not 200. After parsing the XML, sends the result to a
+    # block if given. Use this to validate the response and raise exceptions
+    # when invalid.
+    def post(uri_path, params={})
+      response = Net::HTTP.post_form(URI.join(URI_BASE, uri_path), params)
+      raise WebError, "Invalid response code #{response.code}" unless response.code.to_i == 200
+      response = WebResponse.new(Nokogiri::XML(response.body) do |config|
+        config.strict.nonet
+      end.root)
+      yield response if block_given?
+      response
+    end
+
+    private
+
+    # Answers a block which when it yields raises an exception if the block's
+    # WebResponse argument does not have a message attribute matching the given
+    # string.
+    def raise_block_unless_message(string)
+      Proc.new do |response|
+        raise WebError, "Invalid response message #{response.message_string}" unless response.message_string == string
+      end
+    end
+
+    def raise_block_unless_success
+      raise_block_unless_message 'Success'
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,74 @@
+# This file was generated by the `rspec --init` command. Conventionally, all
+# specs live under a `spec` directory, which RSpec adds to the `$LOAD_PATH`.
+# The generated `.rspec` file contains `--require spec_helper` which will cause this
+# file to always be loaded, without a need to explicitly require it in any files.
+#
+# Given that it is always loaded, you are encouraged to keep this file as
+# light-weight as possible. Requiring heavyweight dependencies from this file
+# will add to the boot time of your test suite on EVERY test run, even for an
+# individual file that may not need all of that loaded. Instead, make a
+# separate helper file that requires this one and then use it only in the specs
+# that actually need it.
+#
+# The `.rspec` file also contains a few flags that are not defaults but that
+# users commonly want.
+#
+# See http://rubydoc.info/gems/rspec-core/RSpec/Core/Configuration
+RSpec.configure do |config|
+  # These two settings work together to allow you to limit a spec run
+  # to individual examples or groups you care about by tagging them with
+  # `:focus` metadata. When nothing is tagged with `:focus`, all examples
+  # get run.
+  config.filter_run :focus
+  config.run_all_when_everything_filtered = true
+
+  # Many RSpec users commonly either run the entire suite or an individual
+  # file, and it's useful to allow more verbose output when running an
+  # individual spec file.
+  if config.files_to_run.one?
+    # Use the documentation formatter for detailed output,
+    # unless a formatter has already been configured
+    # (e.g. via a command-line flag).
+    config.default_formatter = 'doc'
+  end
+
+  # Print the 10 slowest examples and example groups at the
+  # end of the spec run, to help surface which specs are running
+  # particularly slow.
+  config.profile_examples = 10
+
+  # Run specs in random order to surface order dependencies. If you find an
+  # order dependency and want to debug it, you can fix the order by providing
+  # the seed, which is printed after each run.
+  #     --seed 1234
+  config.order = :random
+
+  # Seed global randomization in this process using the `--seed` CLI option.
+  # Setting this allows you to use `--seed` to deterministically reproduce
+  # test failures related to randomization by passing the same `--seed` value
+  # as the one that triggered the failure.
+  Kernel.srand config.seed
+
+  # rspec-expectations config goes here. You can use an alternate
+  # assertion/expectation library such as wrong or the stdlib/minitest
+  # assertions if you prefer.
+  config.expect_with :rspec do |expectations|
+    # Enable only the newer, non-monkey-patching expect syntax.
+    # For more details, see:
+    #   - http://myronmars.to/n/dev-blog/2012/06/rspecs-new-expectation-syntax
+    expectations.syntax = :expect
+  end
+
+  # rspec-mocks config goes here. You can use an alternate test double
+  # library (such as bogus or mocha) by changing the `mock_with` option here.
+  config.mock_with :rspec do |mocks|
+    # Enable only the newer, non-monkey-patching expect syntax.
+    # For more details, see:
+    #   - http://teaisaweso.me/blog/2013/05/27/rspecs-new-message-expectation-syntax/
+    mocks.syntax = :expect
+
+    # Prevents you from mocking or stubbing a method that does not exist on
+    # a real object. This is generally recommended.
+    mocks.verify_partial_doubles = true
+  end
+end

data/spec/web_service_spec.rb

@@ -0,0 +1,62 @@
+require 'rspec'
+require 'eod_data'
+
+describe EodData::WebService do
+  let(:web_service) { EodData::WebService.new }
+
+  it 'exists' do
+    expect(web_service).not_to be_nil
+  end
+
+  context 'without username or password' do
+    # Save and restore the environment's user name and password. Store as
+    # instance variables; save before, restore after.
+    before do
+      @username = ENV.delete('EODDATA_USERNAME')
+      @password = ENV.delete('EODDATA_PASSWORD')
+    end
+
+    it 'throws a web error, invalid response code 500' do
+      expect { web_service.exchange_list }.to raise_error(EodData::WebError)
+    end
+
+    after do
+      ENV['EODDATA_USERNAME'] = @username
+      ENV['EODDATA_PASSWORD'] = @password
+    end
+  end
+
+  context 'exchange list' do
+    let(:exchanges) { web_service.exchange_list }
+
+    it 'answers an array of exchange hashes' do
+      expect(exchanges).to be_an_instance_of(Array)
+      expect(exchanges.collect(&:class).uniq).to eq([Hash])
+    end
+
+    it 'values have appropriate types' do
+      exchanges.each do |exchange|
+        %w(last_trade_date_time intraday_start_date).map(&:to_sym).each do |key|
+          expect(exchange[key].class).to eq(DateTime) if exchange[key]
+        end
+        %w(advances declines).map(&:to_sym).each do |key|
+          expect(exchange[key].class).to eq(Fixnum) if exchange[key]
+        end
+        %w(is_intraday has_intraday_product).map(&:to_sym).each do |key|
+          expect([TrueClass, FalseClass]).to include(exchange[key].class) if exchange[key]
+        end
+      end
+    end
+  end
+
+  it 'answers an array of symbols for NYSE' do
+    symbols = web_service.symbol_list('NYSE')
+    expect(symbols).to be_an_instance_of(Array)
+    expect(symbols.collect(&:class).uniq).to eq([Hash])
+    symbols.each do |symbol|
+      %w(date_time).map(&:to_sym).each do |key|
+        expect(symbol[key].class).to eq(DateTime) if symbol[key]
+      end
+    end
+  end
+end

metadata

@@ -0,0 +1,144 @@
+--- !ruby/object:Gem::Specification
+name: eod_data
+version: !ruby/object:Gem::Version
+  version: 0.2.0
+platform: ruby
+authors:
+- Roy Ratcliffe
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-09-03 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: nokogiri
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: teamcity-ruby-client
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: ''
+email:
+- roy@pioneeringsoftware.co.uk
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- eod_data.gemspec
+- lib/eod_data.rb
+- lib/eod_data/version.rb
+- lib/eod_data/web_error.rb
+- lib/eod_data/web_response.rb
+- lib/eod_data/web_service.rb
+- spec/spec_helper.rb
+- spec/web_service_spec.rb
+homepage: ''
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+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.4.6
+signing_key: 
+specification_version: 4
+summary: ''
+test_files:
+- spec/spec_helper.rb
+- spec/web_service_spec.rb