barchart 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: ff46e2ff07f00e03d59fd6db110a98d491dc3b1c
+  data.tar.gz: 75e61c0258d4c7d40015c3cc127c70c89811343e
+SHA512:
+  metadata.gz: fc88e7837821b8ac0da379700e50cdd8cd92426d1bd21eb36a8129694e24109d4cdd36fade051e4bd14245e5082f84e8fb44be66bef05d9631a95cc5c23041e8
+  data.tar.gz: cb3ce3baad7c33b7e3273dbb7cc685c85e67163b39d2be7aeb84161b6b23a8884b7e56930d32c0011577c4b1a02186dc89c057f372fc14c8d516024396125691

data/.gitignore

@@ -0,0 +1,36 @@
+*.gem
+*.rbc
+/.config
+/coverage/
+/InstalledFiles
+/pkg/
+/spec/reports/
+/spec/examples.txt
+/test/tmp/
+/test/version_tmp/
+/tmp/
+
+## Specific to RubyMotion:
+.dat*
+.repl_history
+build/
+
+## Documentation cache and generated files:
+/.yardoc/
+/_yardoc/
+/doc/
+/rdoc/
+
+## Environment normalization:
+/.bundle/
+/vendor/bundle
+/lib/bundler/man/
+
+# for a library or gem, you might want to ignore these files since the code is
+# intended to run in multiple environments; otherwise, check them in:
+# Gemfile.lock
+# .ruby-version
+# .ruby-gemset
+
+# unless supporting rvm < 1.11.0 or doing something fancy, ignore this:
+.rvmrc

data/.rspec

@@ -0,0 +1,3 @@
+--color
+--require spec_helper
+--format documentation

data/.ruby-version

@@ -0,0 +1 @@
+2.2.3

data/.travis.yml

@@ -0,0 +1,4 @@
+language: ruby
+rvm:
+  - 2.2.3
+before_install: gem install bundler -v 1.10.6

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+ruby '2.2.3'
+
+gemspec

data/Gemfile.lock

@@ -0,0 +1,86 @@
+PATH
+  remote: .
+  specs:
+    barchart (0.0.1)
+      activesupport
+      recursive-open-struct
+      rest-client
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    activesupport (4.2.5)
+      i18n (~> 0.7)
+      json (~> 1.7, >= 1.7.7)
+      minitest (~> 5.1)
+      thread_safe (~> 0.3, >= 0.3.4)
+      tzinfo (~> 1.1)
+    addressable (2.4.0)
+    coderay (1.1.0)
+    crack (0.4.3)
+      safe_yaml (~> 1.0.0)
+    diff-lcs (1.2.5)
+    domain_name (0.5.25)
+      unf (>= 0.0.5, < 1.0.0)
+    hashdiff (0.2.3)
+    http-cookie (1.0.2)
+      domain_name (~> 0.5)
+    i18n (0.7.0)
+    json (1.8.3)
+    method_source (0.8.2)
+    mime-types (2.99)
+    minitest (5.8.4)
+    netrc (0.11.0)
+    pry (0.10.3)
+      coderay (~> 1.1.0)
+      method_source (~> 0.8.1)
+      slop (~> 3.4)
+    recursive-open-struct (1.0.1)
+    rest-client (1.8.0)
+      http-cookie (>= 1.0.2, < 2.0)
+      mime-types (>= 1.16, < 3.0)
+      netrc (~> 0.7)
+    rspec (3.4.0)
+      rspec-core (~> 3.4.0)
+      rspec-expectations (~> 3.4.0)
+      rspec-mocks (~> 3.4.0)
+    rspec-collection_matchers (1.1.2)
+      rspec-expectations (>= 2.99.0.beta1)
+    rspec-core (3.4.1)
+      rspec-support (~> 3.4.0)
+    rspec-expectations (3.4.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.4.0)
+    rspec-its (1.2.0)
+      rspec-core (>= 3.0.0)
+      rspec-expectations (>= 3.0.0)
+    rspec-mocks (3.4.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.4.0)
+    rspec-support (3.4.1)
+    safe_yaml (1.0.4)
+    slop (3.6.0)
+    thread_safe (0.3.5)
+    tzinfo (1.2.2)
+      thread_safe (~> 0.1)
+    unf (0.1.4)
+      unf_ext
+    unf_ext (0.0.7.1)
+    webmock (1.22.6)
+      addressable (>= 2.3.6)
+      crack (>= 0.3.2)
+      hashdiff
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  barchart!
+  pry
+  rspec
+  rspec-collection_matchers
+  rspec-its
+  webmock
+
+BUNDLED WITH
+   1.10.6

data/README.md

@@ -0,0 +1,65 @@
+# barchart
+
+Ruby client library for querying some of [Barchart OnDemand's](http://www.barchartondemand.com/) APIs. 
+
+They have excellent documentation of their APIs [here](http://www.barchartondemand.com/api.php).  
+
+# Configuration
+
+```ruby
+Barchart.configure do |config|
+  config.api_key = 'your_api_key'
+  config.api_base_url = 'http://ondemand.websol.barchart.com'
+end
+```
+# Usage
+
+## Barchart::Quote
+
+```ruby
+Barchart::Quote.get!('AAPL')
+```
+and the output...
+```ruby
+=> #<Barchart::Quote symbol="AAPL", name="Apple Inc", day_code="L", server_timestamp=nil, mode="r", last_price=101.42, trade_timestamp="2016-01-22T00:00:00-06:00", net_change=5.12, percent_change=5.32, bid=0, ask=0, unit_code="2", open=98.63, high=101.46, low=98.37, close=101.42, num_trades=274569, dollar_volume=5844876768.2, flag="s", volume=65800400, previous_volume=52161398>
+```
+
+You can also provide an array of symbols if you like:
+
+```ruby
+Barchart::Quote.get!(['AAPL', 'FB', 'GOOG'])
+```
+
+and you'll get an array of `Barchart::Quote`
+
+```ruby
+=> [#<Barchart::Quote symbol="AAPL", name="Apple Inc", day_code="L", server_timestamp=nil, mode="r", last_price=101.42, trade_timestamp="2016-01-22T00:00:00-06:00", net_change=5.12, percent_change=5.32, bid=0, ask=0, unit_code="2", open=98.63, high=101.46, low=98.37, close=101.42, num_trades=274569, dollar_volume=5844876768.2, flag="s", volume=65800400, previous_volume=52161398>,
+ #<Barchart::Quote symbol="FB", name="Facebook Inc", day_code="L", server_timestamp=nil, mode="r", last_price=97.94, trade_timestamp="2016-01-22T00:00:00-06:00", net_change=3.78, percent_change=4.01, bid=0, ask=0, unit_code="2", open=96.41, high=98.07, low=95.49, close=97.94, num_trades=127919, dollar_volume=2664720705.58, flag="s", volume=30495300, previous_volume=30518898>,
+ #<Barchart::Quote symbol="GOOG", name="Alphabet Inc Class C", day_code="L", server_timestamp=nil, mode="r", last_price=725.25, trade_timestamp="2016-01-22T00:00:00-06:00", net_change=18.66, percent_change=2.64, bid=0, ask=0, unit_code="2", open=723.6, high=728.13, low=720.12, close=725.25, num_trades=9735, dollar_volume=982119017.648, flag="s", volume=2011700, previous_volume=2412200>]
+ ```
+
+## Barchart::History
+
+Returns historical quotes for equities, indices, and forex.  Specifying `endDate` is optional, defaults to `nil`.
+
+```ruby
+Barchart::History.get!('AAPL', 1.week.ago)
+```
+
+and you'll get the daily history, an array of `Barchart::History` objects
+
+
+```ruby
+=> [#<Barchart::History symbol="AAPL", timestamp="2016-01-19T00:00:00-05:00", trading_day="2016-01-19", open=98.41, high=98.65, low=95.5, close=96.66, volume=53087700, open_interest=nil>,
+#<Barchart::History symbol="AAPL", timestamp="2016-01-20T00:00:00-05:00", trading_day="2016-01-20", open=95.1, high=98.19, low=93.42, close=96.79, volume=72334400, open_interest=nil>,
+#<Barchart::History symbol="AAPL", timestamp="2016-01-21T00:00:00-05:00", trading_day="2016-01-21", open=97.06, high=97.88, low=94.94, close=96.3, volume=52161400, open_interest=nil>,
+#<Barchart::History symbol="AAPL", timestamp="2016-01-22T00:00:00-05:00", trading_day="2016-01-22", open=98.63, high=101.46, low=98.37, close=101.42, volume=65800400, open_interest=nil>]
+```
+
+# Interactive Console
+
+This is useful if you just want to try out the package, you'll stil need to initialize Barchart with some valid configuration
+
+```bash
+bin/console
+```

data/Rakefile

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

data/barchart.gemspec

@@ -0,0 +1,30 @@
+# -*- encoding: utf-8 -*-
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+
+require "barchart/version"
+
+Gem::Specification.new do |gem|
+  gem.name          = "barchart"
+  gem.version       = Barchart::VERSION
+  gem.authors       = ["Karney Li"]
+  gem.email         = ["karney@wealthsimple.com"]
+  gem.description   = %q{}
+  gem.summary       = %q{}
+  gem.homepage      = ""
+
+  gem.files         = `git ls-files`.split($/)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.require_paths = ["lib"]
+
+  gem.add_dependency "rest-client"
+  gem.add_dependency "activesupport"
+  gem.add_dependency "recursive-open-struct"
+
+  gem.add_development_dependency "rspec"
+  gem.add_development_dependency "rspec-its"
+  gem.add_development_dependency "rspec-collection_matchers"
+  gem.add_development_dependency "webmock"
+  gem.add_development_dependency "pry"
+end

data/bin/console

@@ -0,0 +1,11 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "barchart"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+require "pry"
+Pry.start

data/bin/setup

@@ -0,0 +1,7 @@
+#!/bin/bash
+set -euo pipefail
+IFS=$'\n\t'
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/console

@@ -0,0 +1,4 @@
+#!/usr/bin/env ruby
+require 'pry'
+require './lib/barchart'
+pry

data/lib/barchart.rb

@@ -0,0 +1,15 @@
+require 'json'
+require 'rest-client'
+require 'active_support'
+require 'active_support/core_ext'
+require 'recursive-open-struct'
+
+require 'barchart/version'
+require 'barchart/configuration'
+require 'barchart/request'
+require 'barchart/resources/resource'
+require 'barchart/resources/quote'
+require 'barchart/resources/history'
+
+module Barchart
+end

data/lib/barchart/configuration.rb

@@ -0,0 +1,26 @@
+module Barchart
+  class << self
+    attr_writer :configuration
+  end
+
+  def self.configuration
+    @configuration ||= Configuration.new
+  end
+
+  def self.configure
+    yield(configuration)
+  end
+
+  def self.reset_configuration!
+    @configuration = Configuration.new
+  end
+
+  class Configuration
+    ATTRIBUTES = [:api_key, :api_base_url]
+    attr_accessor *ATTRIBUTES
+
+    def validate!
+      raise "Invalid or missing configuration"  unless ATTRIBUTES.all? { |attribute| send(attribute).present? }
+    end
+  end
+end

data/lib/barchart/request.rb

@@ -0,0 +1,66 @@
+module Barchart
+  class Request
+    attr_reader :method, :path, :body
+
+    def initialize(method:, path:, body: nil)
+      Barchart.configuration.validate!
+      @method = method
+      @path = path
+      @body = body
+    end
+
+    # Define class methods for more succinct requests
+    %i(get post put delete head patch).each do |http_method|
+      define_singleton_method(http_method) do |path, body=nil|
+        Request.new(method: http_method, path: path, body: body).execute
+      end
+    end
+
+    def execute
+      p url
+      response = RestClient::Request.new({
+        url: url,
+        method: method,
+        headers: {
+          'Content-Type': 'application/json',
+          'Date': Time.now.utc.httpdate,
+        },
+        payload: body_to_json,
+      }).execute
+
+      convert_hash_keys(JSON.parse(response))
+    end
+
+  private
+
+    def url
+      base_url = Barchart.configuration.api_base_url
+      base_url += "/"  unless base_url.end_with?("/")
+      base_url += path.sub(%r{^/}, '')
+
+      base_url += path =~ /\?/ ? '&' : '?'
+      base_url += "apikey=#{Barchart.configuration.api_key}"
+      base_url
+    end
+
+    def underscore_key(k)
+      k.to_s.underscore.to_sym
+    end
+
+    def convert_hash_keys(value)
+      case value
+      when Array then value.map { |v| convert_hash_keys(v) }
+      when Hash then Hash[value.map { |k, v| [underscore_key(k), convert_hash_keys(v)] }]
+      else value
+      end
+    end
+
+    def body_to_json
+      if body
+        body.is_a?(String) ? body : body.to_json
+      else
+        nil
+      end
+    end
+  end
+end

data/lib/barchart/resources/history.rb

@@ -0,0 +1,24 @@
+module Barchart
+  # http://www.barchartondemand.com/api/getHistory
+
+  # The getHistory API is used to request historical time series data on stocks,
+  # indices, mutual funds, ETFs, futures, indices or forex pairs.
+  # Historical data is available as tick, minute or end-of-day data.
+
+
+  class History < Resource
+    # see the API documentation for values for type
+    def self.get!(symbol, start_date=Date.today, end_date=nil)
+
+      start_date_query = "startDate=#{start_date.strftime('%Y%m%d')}"  if start_date
+      end_date_query = "endDate=#{end_date.strftime('%Y%m%d')}"  if end_date
+      symbol_query = "symbol=#{symbol}"
+      type_query = "type=daily"
+
+      params = [symbol_query, type_query, start_date_query, end_date_query].compact.join('&')
+      response = Request.get("/getHistory.json?#{params}")
+
+      response[:results].map { |result| History.new(result) }
+    end
+  end
+end

data/lib/barchart/resources/quote.rb

@@ -0,0 +1,18 @@
+module Barchart
+  # http://www.barchartondemand.com/api/getQuote
+  class Quote < Resource
+    # mode can be R (realtime), I (delayed), D (end-of-day)
+    def self.get!(symbols, fields=[:bid,:ask], mode='R')
+      fields_query = fields.join(',')
+
+      symbols_query = symbols
+      symbols_query = symbols.join(',')  if symbols.is_a?(Array)
+
+      response = Request.get("/getQuote.json?symbols=#{symbols_query}&fields=#{fields_query}")
+
+      return Quote.new(response[:results].first)  if symbols.is_a?(String)
+      response[:results].map { |result| Quote.new(result) }
+    end
+
+  end
+end

data/lib/barchart/resources/resource.rb

@@ -0,0 +1,30 @@
+module Barchart
+  class Resource
+
+    def self.initialize_from_array_response(resource_class, response)
+      JSON.parse(response.body).map do |resource_json|
+        resource_class.new(resource_json)
+      end
+    end
+
+    attr_reader :response_json, :struct
+
+    def initialize(response)
+      @response_json = response
+      @struct = RecursiveOpenStruct.new(@response_json, {recurse_over_arrays: true})
+    end
+
+    def as_json(options = {})
+      @response_json
+    end
+
+    def method_missing(name, *args)
+      @struct[name.to_sym]
+    end
+
+    def inspect
+      @struct.inspect.gsub(/#<RecursiveOpenStruct/,"#<#{self.class.name}")
+    end
+
+  end
+end

data/lib/barchart/version.rb

@@ -0,0 +1,3 @@
+module Barchart
+  VERSION = "0.0.1"
+end

data/spec/barchart_spec.rb

@@ -0,0 +1,11 @@
+require 'spec_helper'
+
+describe Barchart do
+  it 'has a version number' do
+    expect(Barchart::VERSION).not_to be nil
+  end
+
+  it 'does something useful' do
+    expect(true).to eq(true)
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,2 @@
+$LOAD_PATH.unshift File.expand_path('../../lib', __FILE__)
+require 'barchart'

metadata

@@ -0,0 +1,180 @@
+--- !ruby/object:Gem::Specification
+name: barchart
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Karney Li
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-01-25 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rest-client
+  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: recursive-open-struct
+  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: 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: rspec-its
+  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-collection_matchers
+  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: webmock
+  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: pry
+  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:
+- karney@wealthsimple.com
+executables:
+- console
+- setup
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".ruby-version"
+- ".travis.yml"
+- Gemfile
+- Gemfile.lock
+- README.md
+- Rakefile
+- barchart.gemspec
+- bin/console
+- bin/setup
+- console
+- lib/barchart.rb
+- lib/barchart/configuration.rb
+- lib/barchart/request.rb
+- lib/barchart/resources/history.rb
+- lib/barchart/resources/quote.rb
+- lib/barchart/resources/resource.rb
+- lib/barchart/version.rb
+- spec/barchart_spec.rb
+- spec/spec_helper.rb
+homepage: ''
+licenses: []
+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.5.1
+signing_key: 
+specification_version: 4
+summary: ''
+test_files:
+- spec/barchart_spec.rb
+- spec/spec_helper.rb