reuters 0.8.1

data/lib/reuters/credentials.rb

@@ -0,0 +1,79 @@
+module Reuters
+
+  # The {Credentials} module handles storing the
+  # configured credentials for the {Reuters} gem.
+  #
+  # @example Configuring credentials.
+  #   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 Credentials
+
+    # @!attribute username
+    #   @!scope class
+    #   The username to use to authenticate against the
+    #   Reuter's API with.
+    #   @return [String, Nil] The configured username, or nil if
+    #     none is set.
+
+    # @!attribute password
+    #   @!scope class
+    #   The password to use to authenticate against the
+    #   Reuter's API with.
+    #   @return [String, Nil] The configured password, or nil if
+    #     none is set.
+
+    # @!attribute app_id
+    #   @!scope class
+    #   The application ID to use for all requests to the
+    #   Reuter's API.
+    #   @return [String, Nil] The configured appication ID, or nil if
+    #     none is set.
+
+    mattr_accessor :username
+    self.username = nil
+
+    mattr_accessor :password
+    self.password = nil
+
+    mattr_accessor :app_id
+    self.app_id = nil
+
+    # Yields the configured credentials to connect to the
+    # Reuter's API with.
+    #
+    # @yield [username, password, app_id] Yields authentication information.
+    #
+    # @yieldparam [String, Nil] username configured, or nil if one is not set.
+    # @yieldparam [String, Nil] password configured, or nil if one is not set.
+    # @yieldparam [String, Nil] app_id configured, or nil if one is not set.
+    def self.details
+      yield @@username, @@password, @@app_id
+    end
+
+    # Returns credentials that have been configured as a Hash.
+    #
+    # @return [Hash] the credentials that have been configured.
+    def self.to_h
+      { username: username, password: password, app_id: app_id }
+    end
+
+    # Enables credentials to be configured by passing in
+    # itself as a block which enables static variables to
+    # be set.
+    #
+    # @yield [config] The credentials to be configured.
+    def self.configure
+      yield self
+    end
+
+  end
+
+end

data/lib/reuters/namespaces.rb

@@ -0,0 +1,25 @@
+require 'reuters/namespaces/base'
+require 'reuters/namespaces/token'
+require 'reuters/namespaces/common'
+require 'reuters/namespaces/fundamentals'
+require 'reuters/namespaces/search'
+
+module Reuters
+  # The {Namespaces} module contains sets of endpoints that
+  # are used by Reuters in their internal API. Different
+  # Namespaces are used by various clients to gain access
+  # to data via API Calls to these namespaced endpoints.
+  module Namespaces
+
+    # Configure a Namespaces stored configurations.
+    #
+    # @note The passed in namespace is converted to a string
+    #   and capitalized. It should be in the correct form.
+    #
+    # @param [Symbol] namespace to configure endpoints for.
+    def self.configure(namespace, &block)
+      const_get(namespace.to_s).configure(&block)
+    end
+
+  end
+end

data/lib/reuters/namespaces/base.rb

@@ -0,0 +1,47 @@
+module Reuters
+  module Namespaces
+    # The Base Namespace module is not meant to be directly
+    # used as it does not provided any Namespace definitions.
+    # Instead, it is included inside other Namespace modules as
+    # it provides useful helpers.
+    module Base
+
+      # Class based methods that are set in every
+      # module that includes this base module.
+      module ClassMethods
+
+        # Represents the fully resolved namespace endpoint
+        # for the Namespace module that has included this
+        # class method.
+        #
+        # @note The returned string is prefixed with the configured
+        #   #namespaces_endpoint.
+        #
+        # @return [String] the fully resolved namespace endpoint.
+        def endpoint
+          "#{Reuters.namespaces_endpoint}/#{year}/#{month}/#{day}/webservices/rkd/#{name}"
+        end
+
+        # Enables this namespace to be configured by passing in
+        # itself as a block which enables static variables to
+        # be set.
+        #
+        # @yield [config] The namespace to be configured.
+        def configure
+          yield self
+        end
+
+      end
+
+      # @!parse extend ClassMethods
+      extend ClassMethods
+
+      # Extend the including class with the defined
+      # class methods.
+      def self.included(klass)
+        klass.extend(ClassMethods)
+      end
+
+    end
+  end
+end

data/lib/reuters/namespaces/common.rb

@@ -0,0 +1,30 @@
+module Reuters
+  module Namespaces
+    # Common namespaces are used in most API Calls and represent
+    # the common set of Namespaces shared amongst most Reuters
+    # API requests.
+    module Common
+
+      # @!parse include Base
+
+      include Base
+
+      # Year for the Common endpoint.
+      mattr_accessor :year
+      self.year = '2006'
+
+      # Month for the Common endpoint.
+      mattr_accessor :month
+      self.month = '05'
+
+      # Day for the Common endpoint.
+      mattr_accessor :day
+      self.day = '01'
+
+      # Name for the Common endpoint.
+      mattr_accessor :name
+      self.name = 'Common_1'
+
+    end
+  end
+end

data/lib/reuters/namespaces/fundamentals.rb

@@ -0,0 +1,31 @@
+module Reuters
+  module Namespaces
+    # The Fundamentals namespace can be used for ascertain
+    # important information about companies appearing on the
+    # Reuters API. This Namespace is used by all the accompanying
+    # Fundamental Client API calls.
+    module Fundamentals
+
+      # @!parse include Base
+
+      include Base
+
+      # Year for the Fundamentals endpoint.
+      mattr_accessor :year
+      self.year = '2009'
+
+      # Month for the Fundamentals endpoint.
+      mattr_accessor :month
+      self.month = '01'
+
+      # Day for the Fundamentals endpoint.
+      mattr_accessor :day
+      self.day = '26'
+
+      # Name for the Fundamentals endpoint.
+      mattr_accessor :name
+      self.name = 'Fundamentals_1'
+
+    end
+  end
+end

data/lib/reuters/namespaces/search.rb

@@ -0,0 +1,48 @@
+require 'reuters/namespaces/search/equity'
+
+module Reuters
+  module Namespaces
+    # Represents the base search namespaces. Note that because
+    # search is quite a broad namespace inside the Reuters api,
+    # it is better to use a more specific namespace such as
+    # {Reuters::Namespaces::Search::Equity}.
+    module Search
+
+      # @!parse include Base
+
+      include Base
+
+      # Year for the Search Equity endpoint.
+      mattr_accessor :year
+      self.year = '2006'
+
+      # Month for the Search Equity endpoint.
+      mattr_accessor :month
+      self.month = '05'
+
+      # Day for the Search Equity endpoint.
+      mattr_accessor :day
+      self.day = '01'
+
+      # Name for the Search Equity endpoint.
+      mattr_accessor :name
+      self.name = 'Search'
+
+      # Define a custom name or endpoint that Reuters uses
+      # to define XML Namespaces inside the request body.
+      #
+      # @example Defining a custom namespace
+      #   str = Reuters::Namespaces::Search.define(:equity_quote, :query_spec, 1)
+      #   puts str #=> "http://.../Search/EquityQuote_QuerySpec_1"
+      # @param [String] strs to convert into a valid namespace
+      #
+      # @return [String] A full namespaced endpoint with a underscore
+      #   separated camelized definition.
+      def self.define(*strs)
+        str = strs.map { |s| s.to_s.camelize }.join('_')
+        "#{endpoint}/#{str}"
+      end
+
+    end
+  end
+end

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

@@ -0,0 +1,32 @@
+module Reuters
+  module Namespaces
+    module Search
+      # Represents the Search Equity namespace that can be
+      # used to query for information about Company
+      # financial information.
+      module Equity
+
+        # @!parse include Base
+
+        include Base
+
+        # Year for the Search Equity endpoint.
+        mattr_accessor :year
+        self.year = '2006'
+
+        # Month for the Search Equity endpoint.
+        mattr_accessor :month
+        self.month = '05'
+
+        # Day for the Search Equity endpoint.
+        mattr_accessor :day
+        self.day = '01'
+
+        # Name for the Search Equity endpoint.
+        mattr_accessor :name
+        self.name = 'Search/EquityQuote_1'
+
+      end
+    end
+  end
+end

data/lib/reuters/namespaces/token.rb

@@ -0,0 +1,30 @@
+module Reuters
+  module Namespaces
+    # Represents namespaces used by Reuters in their internal API for
+    # managing Access Tokens that are granted when valid credentials
+    # are used to authenticate.
+    module Token
+
+      # @!parse include Base
+
+      include Base
+
+      # Year for the TokenManagement endpoint.
+      mattr_accessor :year
+      self.year = '2006'
+
+      # Month for the TokenManagement endpoint.
+      mattr_accessor :month
+      self.month = '05'
+
+      # Day for the TokenManagement endpoint.
+      mattr_accessor :day
+      self.day = '01'
+
+      # Name for the TokenManagement endpoint.
+      mattr_accessor :name
+      self.name = 'TokenManagement_1'
+
+    end
+  end
+end

data/lib/reuters/response.rb

@@ -0,0 +1,32 @@
+module Reuters
+  # This class parses Savon response bodies into more practical
+  # accessible objects, by using a recursive strategy for parsing
+  # the content. 
+  #
+  # @note All attributes for XML elements can be accessed via the
+  #   attributes accessor.
+  class Response < Hash
+
+    attr_accessor :body, :attributes
+
+    def initialize(body = {})
+      unless body.empty?
+        merge! body
+        attribs = body.keep_if { |k| k.match(/@/) }
+        attribs = Hash[attribs.map { |k, v| [k.to_s.gsub(/@/, '').to_sym, v] }]
+        @attributes = self.class.new attribs
+      end
+    end
+
+    def method_missing(name)
+      if key?(name)
+        if (val = self[name]).is_a? String
+          val
+        else
+          self.class.new val
+        end
+      end
+    end
+
+  end
+end

data/lib/reuters/version.rb

@@ -0,0 +1,6 @@
+# Ruby Gem for interacting with the Thomson Reuters
+# Knowledge Direct API.
+module Reuters
+  # Current version of the Reuters gem.
+  VERSION = '0.8.1'
+end

data/lib/reuters/wsdls.rb

@@ -0,0 +1,25 @@
+require 'reuters/wsdls/base'
+require 'reuters/wsdls/token'
+require 'reuters/wsdls/fundamentals'
+require 'reuters/wsdls/search'
+
+module Reuters
+  # The {Wsdls} module contains sets of endpoints that
+  # are used by Reuters in their internal API. Wsdls describe
+  # valid operations that can be carried out through API
+  # requests. Each API group should have an accompanying
+  # WSDL, as they are used to make {Client} requests.
+  module Wsdls
+
+    # Configure a Wsdls stored configurations.
+    #
+    # @note The passed in wsdl is converted to a string
+    #   and capitalized. It should be in the correct form.
+    #
+    # @param [Symbol] wsdl to configure endpoints for.
+    def self.configure(wsdl, &block)
+      const_get(wsdl.to_s).configure(&block)
+    end
+
+  end
+end

data/lib/reuters/wsdls/base.rb

@@ -0,0 +1,44 @@
+module Reuters
+  module Wsdls
+    # The Base WSDL module is not meant to be directly
+    # used as it does not provided any WSDL definitions.
+    # Instead, it is included inside other WSDL modules as
+    # it provides useful helpers.
+    module Base
+
+      # Class based methods that are set in every
+      # module that includes this base module.
+      module ClassMethods
+
+        # Returns the fully resolved WSDL endpoint for the
+        # including Module.
+        #
+        # @return [String] the fully resolved wsdl endpoint
+        #   (including http://...)
+        def endpoint
+          "#{Reuters.wsdl_endpoint}/#{name}/wsdl/#{method}"
+        end
+
+        # Enables this WSDL to be configured by passing in
+        # itself as a block which enables static variables to
+        # be set.
+        #
+        # @yield [config] The WSDL to be configured.
+        def configure
+          yield self
+        end
+
+      end
+
+      # @!parse extend ClassMethods
+      extend ClassMethods
+
+      # Extend the including class with the defined
+      # class methods.
+      def self.included(klass)
+        klass.extend(ClassMethods)
+      end
+
+    end
+  end
+end