reuters 0.8.1

data/lib/reuters/wsdls/fundamentals.rb

@@ -0,0 +1,21 @@
+module Reuters
+  module Wsdls
+    # Represents the Wsdl endpoint that will be used to
+    # make Fundamentals Reuters API calls.
+    module Fundamentals
+
+      # @!parse include Base
+
+      include Base
+
+      # Wsdl for the TokenManagement endpoint.
+      mattr_accessor :name
+      self.name = 'Fundamentals'
+
+      # Method to use for the Wsdl
+      mattr_accessor :method
+      self.method = 'Fundamentals_1_HttpAndRkdToken_Soap11.wsdl'
+
+    end
+  end
+end

data/lib/reuters/wsdls/search.rb

@@ -0,0 +1,13 @@
+require 'reuters/wsdls/search/equity'
+
+module Reuters
+  module Wsdls
+    # Represents the WSDL endpoints for all Search API calls.
+    #
+    # @note This Wsdl module does not contain any endpoint
+    #   information, as it is recommended to use a specific
+    #   endpoint, such as {Reuters::Wsdls::Search::Equity}.
+    module Search
+    end
+  end
+end

data/lib/reuters/wsdls/search/equity.rb

@@ -0,0 +1,25 @@
+module Reuters
+  module Wsdls
+    module Search
+      # The Equity Search WSDL endpoint is used by the
+      # {Reuters::Client::Search::Equity} class to discover
+      # and make search-based API calls.
+      module Equity
+
+        # @!parse include Base
+
+        include Base
+
+        # Wsdl for the TokenManagement endpoint.
+        mattr_accessor :name
+        self.name = 'Search'
+
+        # Default method for this Wsdl
+        mattr_accessor :method
+        self.name = 'EquityQuote_1_HttpAndRkdToken_Soap11.wsdl'
+
+      end
+
+    end
+  end
+end

data/lib/reuters/wsdls/token.rb

@@ -0,0 +1,22 @@
+module Reuters
+  module Wsdls
+    # Represents the WSDL used by Reuters in their internal API for
+    # providing information related to the operations that can be
+    # performed to retrieve access tokens.
+    module Token
+
+      # @!parse include Base
+
+      include Base
+
+      # Wsdl for the TokenManagement endpoint.
+      mattr_accessor :name
+      self.name = 'TokenManagement'
+
+      # Method to use for the Wsdl
+      mattr_accessor :method
+      self.method = 'TokenManagement_1_HttpsAndAnonymous_Soap11.wsdl'
+
+    end
+  end
+end

data/reuters.gemspec

@@ -0,0 +1,41 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'reuters/version'
+
+Gem::Specification.new do |spec|
+
+  # Only with >= Ruby 2
+  spec.required_ruby_version = '>= 2.0.0'
+
+  spec.name          = "reuters"
+  spec.version       = Reuters::VERSION
+  spec.authors       = ['Stockflare']
+  spec.email         = ['info@stockflare.com']
+  spec.summary       = %q(Ruby client for Thomson Reuters Knowledge Direct (TRKD) API)
+  spec.description   = %q(Ruby Gem for interacting with the Thomson Reuters Knowledge Direct API)
+  spec.homepage      = 'https://github.com/stockflare/reuters'
+  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_dependency "savon", "~> 2.5.1"
+  spec.add_dependency "activesupport"
+
+  spec.add_development_dependency 'bundler', '~> 1.6'
+  spec.add_development_dependency 'rake'
+  spec.add_development_dependency 'rspec'
+  spec.add_development_dependency 'yard'
+  spec.add_development_dependency 'faker'
+  spec.add_development_dependency 'redcarpet'
+  spec.add_development_dependency 'cucumber'
+  spec.add_development_dependency 'aruba'
+  spec.add_development_dependency 'factory_girl'
+  spec.add_development_dependency 'codeclimate-test-reporter'
+  spec.add_development_dependency 'coveralls'
+  spec.add_development_dependency 'rubocop'
+
+end

data/spec/fixtures/responses/token.xml

@@ -0,0 +1,11 @@
+<s:Envelope 
+    xmlns:s="http://schemas.xmlsoap.org/soap/envelope/">
+    <s:Body>
+        <CreateServiceToken_Response_1 
+            xmlns="http://www.reuters.com/ns/2006/05/01/webservices/rkd/TokenManagement_1" 
+            xmlns:global="http://www.reuters.com/ns/2006/05/01/webservices/rkd/Common_1">
+            <Expiration>2014-05-14T19:05:04.8429795Z</Expiration>
+            <global:Token>92C6ECD09825AC24C977F352FB31F8E4DF10BC84502A1CBDDF4636371E6714BA6DB028EAB6B832398B64AFE7895D53521C7F4CB84AF643D902E7707887C62DBEAF7398A9AB812B817F9C06B476EA6A017B629BE78FB965F4B2B46CCC7BCCF993</global:Token>
+        </CreateServiceToken_Response_1>
+    </s:Body>
+</s:Envelope>

data/spec/reuters/builder_spec.rb

@@ -0,0 +1,189 @@
+require 'spec_helper'
+
+describe Reuters::Builder do
+
+  before { @builder = Reuters::Builder.new }
+
+  subject { @builder }
+
+  it { should respond_to(:attributes) }
+
+  it "should correctly camelcase a body key" do
+    @builder.test_method
+    expect(@builder.keys).to include("TestMethod")
+  end
+
+  it "should call a block" do
+    expect { |b| Reuters::Builder.new &b }.to yield_control.once
+  end
+
+  it "should pass itself to the block" do
+    expect { |b| Reuters::Builder.new &b }.to yield_with_args(Reuters::Builder)
+  end
+
+  it "should chain body calls inside the block" do
+    b = Reuters::Builder.new { |b| b.test_method }
+    expect(b).to include("TestMethod")
+  end
+
+  describe "return value of #keys" do
+    before do
+      @builder.foo_test
+      @builder.bar_test
+    end
+
+    it "should include camelcased keys" do
+      expect(@builder.keys).to include("FooTest", "BarTest")
+    end
+
+    it "should not include underscored keys" do
+      expect(@builder.keys).to_not include(:foo_test, :bar_test, 'foo_test', 'bar_test')
+    end
+
+    it "should not be empty" do
+      expect(@builder.keys).to_not be_empty
+    end
+
+    it "should add new keys" do
+      expect { @builder.david }.to change { @builder.keys }
+    end
+
+    it "should not include attributes!" do
+      expect(@builder.keys).to_not include(:attributes!)
+    end
+  end
+
+  describe "return value of #key?" do
+
+    before { @builder.test_build }
+
+    it "should allow camelcase keys" do
+      expect(@builder.key?("TestBuild")).to be_true
+    end
+
+    it "should allow underscore keys" do
+      expect(@builder.key?(:test_build)).to be_true
+    end
+
+  end
+
+  describe "when a block is passed to a nested builder" do
+
+    it "should call the block" do
+      expect { |b| @builder.foo.bar &b }.to yield_control.once
+    end
+
+    it "should enable modifications inside the block" do
+      @builder.foo.bar { |body| body.test = 1 }
+      expect(@builder.foo.bar.key?(:test)).to_not be_false
+    end
+
+  end
+
+  describe "when attributes are set" do
+
+    let(:attributes) { { "xmlns" => "http://..." } }
+
+    it "should set attributes" do
+      @builder.test(attributes)
+      expect(@builder[:attributes!]["Test"]).to include "Xmlns"
+    end
+
+    describe "when camelcasing is disabled" do
+
+      it "should still camcelcase the key" do
+        @builder.test(attributes, false)
+        expect(@builder[:attributes!]).to include "Test"
+      end
+
+      it "should set attributes that aren't camelcased" do
+        @builder.test(attributes, false)
+        expect(@builder[:attributes!]["Test"]).to include "xmlns"
+      end
+
+    end
+
+  end
+
+  describe "when a chain of keys is set" do
+
+    it "should set all keys" do
+      expect(@builder.this.is.a.chain).to_not be_nil
+    end
+
+    it "should set attributes for a nested key" do
+      @builder.this(a: 1).is.a(b: 2).chain
+      expect(@builder[:attributes!]).to include({"This" => { "A" => 1}})
+    end
+
+    it "should set nested attributes for a nested key" do
+      @builder.this(a: 1).is.a(b: 2).chain
+      expect(@builder.this.is[:attributes!]).to include({"A" => { "B" => 2}})
+    end
+
+  end
+
+  describe "when the value is explicitly set" do
+
+    it "should set a string" do
+      @builder.test = "foobar"
+      expect(@builder).to include({"Test" => "foobar"})
+    end
+
+    it "should set an array" do
+      @builder.test = [1,2,3,4]
+      expect(@builder).to include({"Test" => [1,2,3,4]})
+    end
+
+    it "should set an integer" do
+      @builder.test = 1
+      expect(@builder).to include({"Test" => 1})
+    end
+
+  end
+
+  it "should set attributes for a key" do
+    @builder.test a: true
+    expect(@builder[:attributes!]).to include("Test")
+  end
+
+  it "should camelize attribute keys" do
+    @builder.test a: 1
+    expect(@builder[:attributes!]["Test"]).to include "A"
+  end
+
+  it "should set multiple attributes for a key" do
+    @builder.test a: 1, b: 2, c: 3
+    expected_attributes = { "A" => 1, "B" => 2, "C" => 3 }
+    expect(@builder[:attributes!]["Test"]).to include expected_attributes
+  end
+
+  describe "when the key is an array" do
+
+    let(:test_array) { [{a: 1, b: 2}, {a: 3, b: 4}] }
+
+    before { @builder.test test_array }
+
+    it "should set an array for the key" do
+      expect(@builder["Test"]).to be_a(Array)
+    end
+
+    it "should set an array of the correct length" do
+      expect(@builder["Test"].count).to eq test_array.count
+    end
+
+    it "should set an attribute for the key" do
+      expect(@builder[:attributes!]["Test"]).to be_a(Hash)
+    end
+
+    it "should include the attribute keys" do
+      expect(@builder[:attributes!]["Test"].keys).to include("A", "B")
+    end
+
+    it "should order the attributes correctly" do
+      expect(@builder[:attributes!]["Test"]["A"]).to eq ["1","3"]
+    end
+
+  end
+
+end

data/spec/reuters/client/fundamentals_spec.rb

@@ -0,0 +1,11 @@
+require 'spec_helper'
+
+describe Reuters::Client::Fundamentals do
+
+  before { @fundamentals = Reuters::Client::Fundamentals.new }
+
+  subject { @fundamentals }
+
+  it_behaves_like "a client class"
+
+end

data/spec/reuters/client/search/equity_spec.rb

@@ -0,0 +1,46 @@
+require 'spec_helper'
+
+describe Reuters::Client::Search::Equity do
+
+  before { @equity = Reuters::Client::Search::Equity.new }
+
+  subject { @equity }
+
+  it_behaves_like "a search client class"
+
+  it { should respond_to(:data_type) }
+  it { should respond_to(:query_spec) }
+
+  describe "return value of #data_type" do
+
+    it "should be a string" do
+      expect(@equity.data_type).to be_a(String)
+    end
+
+    it "should be a resolved namespace" do
+      expect(@equity.data_type).to include(Reuters.namespaces_endpoint)
+    end
+
+    it "should include the camelcased data type" do
+      expect(@equity.data_type).to include("QuerySpecDataTypes")
+    end
+
+  end
+
+  describe "return value of #query_spec" do
+
+    it "should be a string" do
+      expect(@equity.query_spec).to be_a(String)
+    end
+
+    it "should be a resolved namespace" do
+      expect(@equity.query_spec).to include(Reuters.namespaces_endpoint)
+    end
+
+    it "should include the camelcased specification namespace" do
+      expect(@equity.query_spec).to include("EquityQuote_QuerySpec_1")
+    end
+
+  end
+  
+end

data/spec/reuters/client/token_spec.rb

@@ -0,0 +1,91 @@
+require 'spec_helper'
+
+describe Reuters::Client::Token do
+
+  before { @token = Reuters::Client::Token.new }
+
+  subject { @token }
+
+  it_behaves_like "a client class"
+
+  it { should respond_to(:token) }
+  it { should respond_to(:expiration) }
+
+  it { should respond_to(:username) }
+  it { should respond_to(:password) }
+  it { should respond_to(:app_id) }
+
+  it { should respond_to(:authenticate) }
+  it { should respond_to(:header) }
+  it { should respond_to(:message) }
+
+  describe "return value of #message" do
+
+    it "should be a request builder object" do
+      expect(@token.message).to be_an_instance_of(Reuters::Builder)
+    end
+
+    it "should include necessary authentication information" do
+      expect(@token.message.keys).to include("ApplicationID", "Username", "Password")
+    end
+
+  end
+
+  describe "return value of #header" do
+
+    include Savon::SpecHelper
+
+    before(:all) { savon.mock! }
+    after(:all) { savon.unmock! }
+
+    before do
+      test_response = File.read("spec/fixtures/responses/token.xml")
+      savon.expects(:create_service_token_1).with(message: :any).returns(test_response)
+    end
+
+    it "should be a request builder object" do
+      expect(@token.header).to be_an_instance_of(Reuters::Builder)
+    end
+
+    it "should include the token and application id" do
+      expect(@token.header.authorization.keys).to include("Token", "ApplicationID")
+    end
+
+  end
+
+  describe "when the user attempts to #authenticate" do
+
+    describe "when the credentials are valid" do
+
+      include Savon::SpecHelper
+
+      before(:all) { savon.mock! }
+      after(:all) { savon.unmock! }
+
+      let(:test_response) { File.read("spec/fixtures/responses/token.xml") }
+
+      before { savon.expects(:create_service_token_1).with(message: :any).returns(test_response) }
+
+      it "should return a token response object" do
+        expect(@token.authenticate).to be_an_instance_of Reuters::Response
+      end
+
+      it "authenticates the user with Reuters API" do
+        expect { @token.authenticate }.to_not raise_error
+      end
+
+      it "populates the response object" do
+        expect(@token.authenticate.token).to_not be_nil
+      end
+
+    end
+
+    describe "when the credentials are not valid" do
+      it "raises a Savon SOAP Client Error" do
+        expect { @token.authenticate }.to raise_error
+      end
+    end
+
+  end
+
+end