reuters 0.8.1

checksums.yaml

@@ -0,0 +1,15 @@
+---
+!binary "U0hBMQ==":
+  metadata.gz: !binary |-
+    OTlkMzQzN2M1ZDVmYzUxMTYyMWYzMmJiYzYxN2YyMmU3ZmE3MGM1Mw==
+  data.tar.gz: !binary |-
+    MTExNGYxYWFjNWE0NWQxZmYyN2FkNjgxMjJmZTI0ZmFlOGMwMjc3NQ==
+SHA512:
+  metadata.gz: !binary |-
+    YjM3NmQxMWQyNzNmMTc5ODFlMmQwNmJkMTMyZTY0ZmVmNGRiNzYyN2E1MTMz
+    NWQ4YjVmYjI4NTZlZjk0MTc0NjEyYzUzMWUwMDE5ZWI0MDdjYzg5NWQ0MjM4
+    ZjI1Yzc0OWQxZmI3Y2U0ZDgwZGFkMzg2MTJhYzViMjNmNzg2YzY=
+  data.tar.gz: !binary |-
+    YTgwN2FmZWJmM2Q0NDdhNzc5ZWEzNDU3NWZhMjhhOTI3NTQ5NDE4MTAxYTBj
+    NWNjMTY3MTIxZjJlOTI5NjE4N2MwYjM3YmEwM2EwMDU4NDgwM2M2M2YyNTIw
+    ZmIxOGI5ODAxOTBhODVhZTM0YWIyOTUwYmIyNjA1NjljZjI5NWQ=

data/.gitignore

@@ -0,0 +1,23 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log
+temp.rb

data/.rubocop.enabled.yml

@@ -0,0 +1,23 @@
+TrailingBlankLines:
+  Description: 'Checks trailing blank lines and final newline.'
+  Enabled: false
+
+EmptyLinesAroundBody:
+  Description: "Keeps track of empty lines around expression bodies."
+  Enabled: false
+
+CaseEquality:
+  Description: 'Avoid explicit use of the case equality operator(===).'
+  Enabled: false
+
+ClassVars:
+  Description: 'Avoid the use of class variables.'
+  Enabled: false
+
+IndentationConsistency:
+  Description: 'Keep indentation straight.'
+  Enabled: false
+
+AccessModifierIndentation:
+  Description: Check indentation of private/protected visibility modifiers.
+  Enabled: true

data/.rubocop.yml

@@ -0,0 +1,15 @@
+inherit_from:
+  - .rubocop.enabled.yml
+
+# Common configuration.
+AllCops:
+  Exclude:
+    - '**/*.gemspec'
+    - 'vendor/**/*'
+    - 'spec/**/*'
+    - 'script/**/*'
+    - 'temp.rb'
+  RunRailsCops: true
+
+LineLength:
+  Max: 100

data/.ruby-gemset

@@ -0,0 +1 @@
+reuters

data/.ruby-version

@@ -0,0 +1 @@
+2.0.0-p353

data/.travis.yml

@@ -0,0 +1,28 @@
+language: ruby
+rvm:
+- 2.0.0-p353
+- 2.1.0
+- ruby-head
+notifications:
+  flowdock:
+    secure: LiGQvTUtEQyFRdM/nIDrzFI7aP5VGymCSGwrOFJ/ej//kiMc4fwjJqA+OD9JHT6bnBHx7BkFqXOMRIOBvxE2v5t0phmNJkEI9wc2Jiq6o9kdhMfVg9IQ8NTNdWK6cRqyfs96mLjFzweN+kUp6UnU/s9iXsU5XdOLYeklkC2U/sI=
+before_deploy:
+- yard doc
+deploy:
+- provider: s3
+  access_key_id: AKIAIWPY43DAALLVSXFQ
+  bucket: reuters.stockflair.com
+  skip_cleanup: true
+  local-dir: doc
+  edge: true
+  region: us-east-1
+  endpoint: s3-us-east-1.amazonaws.com
+  on:
+    branch: master
+  secret_access_key:
+    secure: BS3KV3AbGIxzwmEA53iceavyM6MWuDImiAeIRN0CTiT3yCOsD8m5M8dzB1Uxx0nOQNj3W47ywpD2PDciEyr8RnEjMpLSPfEe1/bBJuiWUGDI5x2w2dg5M02/kJLMS3hFVbEvdoCN2owKpWA4Gm95JvkeWH8eL3JWIi7sxHC+Kxw=
+- provider: rubygems
+  on:
+    branch: master
+  api_key:
+    secure: cDRvAU7Beo+0BNfgbAcyPvaTtR4yv539sm7Lkx0HOUMi+O9L/qhQgCCzacIwUeEAf5kPj9m7HSW5BzLddiOZlQ/rQLFOSctmzeF5Swj/oQZ6OqQDhvjjtazMrNiNvNvGmchbeEBdQw46q/aaAgHsvXWNtEjYES+4+3A8YVtCn+Q=

data/CONTRIBUTING.md

@@ -0,0 +1,37 @@
+# Contributing to Reuters
+
+The Reuters API is vast and has lots of calls that each vary in complexity and usage. At the moment, we only have limited development time, so have only developed the calls that we use. 
+
+If you would like to develop an API Call, open an issue and please feel free to ask for assistance with building it.
+
+You will find that most classes are well documented and we have designed the gem to be as intuitive and flexible to develop as possible. 
+
+If you find a bug, have a feature request or even want to contribute an enhancement or fix, please follow the below guidelines so that we can help you out and/or get your code merged quickly.
+
+## If you find what looks like a bug
+
+* Check the [GitHub issue tracker](http://github.com/stockflare/reuters/issues/) to see if anyone else has reported the issue.
+* Make sure you are using the latest version of Reuters
+* If you are still having an issue, create an issue including:
+  * Information you will need to reproduce and diagnose the problem
+
+## If you want to contribute an enhancement or a fix
+
+0. Discuss any major enhancement with the project moderator.
+0. Write your [Spec tests](http://betterspecs.org/).
+0. Write or modify any affected documentation.
+0. Ensure that your tests work and your documentation is complete.
+
+### General Contributition Guidelines
+
+We follow the standard GitHub fork & pull request approach to open source collaboration. You can find a description on how this works on the [gun.io blog](https://gun.io/blog/how-to-github-fork-branch-and-pull-request/).
+
+In a nutshell:
+
+0. Fork it.
+0. Create your feature branch (`git checkout -b feature/my-new-feature`).
+0. Commit your changes (`git commit -am 'Add some feature'`) and [reference any issues](https://github.com/blog/831-issues-2-0-the-next-generation).
+0. Push to your branch (`git push origin my-new-feature`).
+0. Send a new Pull Request describing what you have done and why, in detail.
+
+**IMPORTANT**: By submitting a patch, you agree to allow the project owners to license your work under the the terms of the MIT license. A copy of this license is provided in the root of the repository.

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Stockflare Ltd.
+
+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
+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/README.md

@@ -0,0 +1,209 @@
+# Thomson Reuters API Client
+
+[![Coverage Status](https://coveralls.io/repos/Stockflare/reuters/badge.png?branch=master)](https://coveralls.io/r/Stockflare/reuters?branch=master) [![Build Status](https://travis-ci.org/Stockflare/reuters.svg?branch=master)](https://travis-ci.org/Stockflare/reuters) [![Dependency Status](https://gemnasium.com/Stockflare/reuters.svg)](https://gemnasium.com/Stockflare/reuters) [![Code Climate](https://codeclimate.com/github/Stockflare/reuters.png)](https://codeclimate.com/github/Stockflare/reuters)
+
+
+Uses the [Reuter's TRKD API](http://thomsonreuters.com/knowledge-direct/) to grab financial data for stocks, such as quotes, estimates and snapshots.
+
+This gem will only work if you have been provided with valid credentials by Reuters. See below for more information about configuring your login credentials.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'reuters'
+
+And then execute:
+
+    $ bundle install
+
+## Usage
+
+This gem provides no CLI and is intended to be used in conjunction with other applications.
+
+### Configuring Credentials
+
+Before any API calls will work, you need to configure the library with valid credentials. Once credentials have been configured, an access token will be retrieved from the Reuter' API upon a client request.
+
+```
+Reuters.configure do |config|
+
+  config.credentials do |login|
+    # Set username
+    login.username = "my_username"
+
+    # Set my password
+    login.password = "my_super_secret_password"
+
+    # Set application ID
+    login.application_id = "application_id"
+  end
+
+end
+```
+
+### Configuring Namespaces and WSDL endpoints
+
+All the default configurations point towards the SOAP11 service that Reuters provides. In our experience, we were unable to get their SOAP 2 service working reliably.
+
+Each class has a `#configure` method that can be used to adjust the endpoints and other attributes of the class, as shown in the example below.
+
+```
+Reuters::Namespaces::Search::Equity.configure do |c|
+  c.name 'Search/A_Different_Equity_1'
+end
+
+```
+
+### Making A Request
+
+There are three components to each request made to the Reuter's API. The `Request` object, the `Client` and finally the `Response`. Because Reuters API calls can become quite complex it would become arduous to build a separate "helper" method for every possible variation on every possible call.
+
+#### Building A Request
+
+All requests to the Reuters API are XML-based. You are responsible for building the request (except for adding the "xmlns" attributes; which should be handled by the client). Every example documented below, can be nested up to n-depth. I have laid out some examples and their XML-counterparts to help you get started with the request builder.
+
+**Note: These are only examples to help you get started with the request builder, and are not valid API Calls**
+
+```
+<Query>
+  <ExchangeCode Include="true">NYSE</ExchangeCode>
+</Query>
+```
+
+```
+message = Reuters::Builder.new
+message.query.exchange_code = "NYSE"
+message.query.exchange_code include: true
+```
+
+You can also pass a block to the builder to achieve the same result:
+
+```
+message = Reuters::Builder.new do |body|
+  body.query do |query|
+    query.exchange_code = "NYSE"
+    query.exchange_code include: true
+  end
+end
+```
+
+---
+
+The builder allows you to very quickly define nested elements with attributes:
+
+```
+<This>
+  <Is>
+    <A>
+      <Nested>
+        <Element Hello="world">
+        </Element>
+      </Nested>
+    </A>
+  </Is>
+</This>
+```
+
+```
+message = Reuters::Builder.new
+message.this.is.a.nested.element hello: "world"
+```
+
+---
+
+The Request Builder also supports building arrays of elements with only attributes, content or both.
+
+```
+<Filter>
+  <ExchangeCode Include="true">
+    <StringValue Value="NSQ" Negated="false" />
+    <StringValue Value="GER" Negated="true" />
+    <StringValue Value="LSE" Negated="false" />
+  </ExchangeCode>
+</Filter>
+```
+
+```
+Reuters::Builder.new do |body|
+  body.filter do |filter|
+    filter.exchange_code include: true do |ex|
+      ex.stringValue [
+        { value: "NSQ", negated: false },
+        { value: "GER", negated: true },
+        { value: "LSE", negated: false },
+      ]
+    end
+  end
+end
+```
+
+```
+<Filter>
+  <ExchangeCode Include="true">
+    <StringValue Negated="false">NSQ</StringValue>
+    <StringValue Negated="true">GER</StringValue>
+    <StringValue Negated="false">LSE</StringValue>
+  </ExchangeCode>
+</Filter>
+```
+
+```
+Reuters::Builder.new do |body|
+  body.filter do |filter|
+    filter.exchange_code include: true do |ex|
+      ex.stringValue [
+        { negated: false },
+        { negated: true },
+        { negated: false },
+      ]
+      ex.stringValue = ["NSQ", "GER", "LSE"]
+    end
+  end
+end
+```
+
+The request that you build, will be sent inside the request element. So there is no need to define any header information.
+
+```
+<Body>
+  <GetEquityQuote_Request_1 ...>
+    <!-- Your request will appear here -->
+  </GetEquityQuote_Request_1>
+</Body>
+```
+
+#### Sending the Request to a Client
+
+When you initialize a client that requires a valid access token, the client will automagically take care of obtaining a token for you when the request is sent (providing you have valid credentials configured).
+
+```
+Reuters::Credentials.configure do |c|
+  c.username = "my_username"
+  c.password = "my_password"
+  c.app_id = "my_app_id"
+end
+
+message = Reuters::Builder.new do |body|
+  ...
+end
+
+client = Reuters::Client::Search::Equity.new
+
+client.operations #=> [:get_equity_quote_1]
+
+client.get_equity_quote_1(message)
+```
+
+#### Using the Response
+
+Different Response classes parse data slightly differently depending on how it is intended to be used. You will need to take a look at the documentation for the Response corresponding to your Client.
+
+
+## Contributing
+
+The Reuters API is vast and has lots of calls that each vary in complexity and usage. At the moment, we only have limited development time, so have only developed the calls that we use. 
+
+If you would like to develop an API Call, open an issue and please feel free to ask for assistance with building it. 
+
+If you find a bug, have a feature request or even want to contribute an enhancement or fix, please follow the contributing guidelines included in the repository.

data/Rakefile

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

data/lib/reuters.rb

@@ -0,0 +1,98 @@
+require 'savon'
+
+require 'active_support/core_ext/module/attribute_accessors'
+require 'active_support/core_ext/module/delegation'
+require 'active_support/core_ext/hash/deep_merge'
+require 'active_support/core_ext/string/inflections'
+require 'active_support/inflector'
+
+require 'reuters/namespaces'
+require 'reuters/wsdls'
+require 'reuters/credentials'
+require 'reuters/version'
+require 'reuters/builder'
+require 'reuters/response'
+require 'reuters/client'
+
+# Ruby Gem for interacting with the Thomson Reuters
+# Knowledge Direct API.
+#
+# @example Configuring the Reuters Gem.
+#   Reuters.configure do |config|
+#     config.credentials do |login|
+#       # Set username
+#       login.username = "my_username"
+#       # Set my password
+#       login.password = "my_super_secret_password"
+#       # Set application ID
+#       login.application_id = "application_id"
+#     end
+#   end
+module Reuters
+
+  # @!attribute namespaces_endpoint
+  #   @!scope class
+  #   The endpoint that will be used to contact Reuters to determine
+  #   the fully resolved namespaces.
+  #   @return [String] The configured namespace endpoint.
+
+  # @!attribute wsdl_endpoint
+  #   @!scope class
+  #   The WSDL endpoint that will be used to contact Reuters.
+  #   @return [String] The configured WSDL endpoint.
+
+  # @!attribute debug
+  #   @!scope class
+  #   Determines if debugging mode is enabled for the Reuters gem.
+  #   If enabled, any Reuters API requests will debug to STDOUT.
+  #   @return [Boolean] False if disabled, true if enabled.
+
+  # Sets whether debugging is enabled for the Reuters API calls.
+  # By default, this value is set to false as to not make any output
+  # unnecessarily noisy.
+  mattr_accessor :debug
+  self.debug = false
+
+  # Set the default Reuters API namespace endpoint. This is the
+  # standard default for most API requests and shouldn't
+  # really need to be changed.
+  mattr_accessor :namespaces_endpoint
+  self.namespaces_endpoint = 'http://www.reuters.com/ns'
+
+  # Set the default Reuter's API WSDL endpoint. This endpoint
+  # sets compatibility for SOAP 1.1 requests and will need to
+  # be changed if you wish to use SOAP 1.2 with the Reuter's API.
+  mattr_accessor :wsdl_endpoint
+  self.wsdl_endpoint = 'http://api.rkd.reuters.com/schemas'
+
+  # Sets Reuters specific acronyms, such as ISIN and RIC.
+  # The API requests these acronyms to be in uppercase
+  # rather than camelcase.
+  mattr_accessor :reuters_acronyms
+  def self.reuters_acronyms=(val)
+    ActiveSupport::Inflector.inflections do |i|
+      val.each { |v| i.acronym v }
+    end
+  end
+
+  # Set the default Reuters Acronyms that consistently appear
+  # throughout the API.
+  self.reuters_acronyms = %w(ID RIC ISIN)
+
+  # Helper to configure the Reuters gem.
+  #
+  # @yield [Reuters] Yields the {Reuters} module.
+  def self.configure
+    yield self
+  end
+
+  # Yield the {Reuters::Credentials} class as a configurable
+  # block. This block helps clients to set their credentials
+  # easily.
+  #
+  # @yield [Reuters::Credentials] Yields the {Credentials} module.
+  def self.credentials(&block)
+    self::Credentials.configure(&block)
+  end
+
+end