capital-iq 0.0.7 → 0.0.11

checksums.yaml

@@ -1,15 +1,15 @@
 ---
 !binary "U0hBMQ==":
   metadata.gz: !binary |-
-    NzdhOGYzODE0MzU1YTdhZTcyNDNjZmMwYmRhZDhmMTIzZDg4MzU0MA==
+    ZTdhNTlhNjg1YTY2ZmY3ZjlmNmE1OTBlNjU5OTdjN2Y4YTUyYjdiNQ==
   data.tar.gz: !binary |-
-    NjQyMTZhZmVmZjU4YzQ2YmMwMjdhMTAxZGE1NzNjNzgzNzA4ODRlYQ==
+    MmNlYjA5ZDI1YzBlODM4NTVkYjIxNzU1NGNhMTMwZGUxNmY5MzU1Mg==
 SHA512:
   metadata.gz: !binary |-
-    ODYwYmJiODVkZTU0ZWFmMzM0NzJhNjFhN2ZkNTVkNDUxZDgyODA0ZTkzODJk
-    YjU4ZWI1MzFmODJhOTUxYzYxNDkxZDQ3YmM0MTFkZGEyZGY0M2M2YzczMDQ3
-    ZDY1MDVmOTE0NGJlZjIwMzE1Y2FlMWVmNDRiZWQ1ODk4YzBlMDg=
+    NDM4YzcxZTcwY2M5NjE3ZTExOTI5N2U0YjYwMTQxZGFjODY0NmVhZTcxNGY5
+    YjE0MjZiOTdhMmFkZjQzOGMwOWQ1MTNjOTNmZmQxOGM3OGUyYzQ5ZjM2MjY2
+    ZTg0MzEwYmYwOTZhM2FjYThkZWFiMGFkNzAwMDIwMjFhMWZiYzk=
   data.tar.gz: !binary |-
-    ZmFkOTM0ODFhN2Y1YjcxZmZmNzNhN2Y0ZWIyNGI2YmRhZTNkMDJjZWI4ZTZl
-    NmQ4YWY5YTA0MTk2ODQxOGY0Mjg4YTk4OThlMzM4MDNmNTI2OTYwZjNlOTRk
-    MzA0NTNlNDM0ODY1YWY0MWY4NmU2NTY0MDA2Y2FjNDk5MDRjMDc=
+    ODQ3NWYwZmIzZTc4Zjk2ODY1ZjY3YWRiYTBjMjNmN2Y0ZjE0MzBmYmExMDcz
+    YzY1MjJiMjk2Zjk0OGQ2N2U2MGU4ZGE0OTZjYThjYjEwZjljOTdmOGMzZWI2
+    N2E4OWI3YjkwMGI5YzZhMmM4ZDJlMjcwOTA3ODJkMmNhNWRjZTk=

data/Gemfile

@@ -1,16 +1,19 @@
 source "http://rubygems.org"
+ruby "1.9.3"
 
 group :development do
-  gem "rspec", "~> 2.8.0"
-  gem "rdoc", "~> 3.12"
+  gem "rspec"
+  gem "rdoc"
   gem "bundler"
-  gem "jeweler", "~> 1.8.3"
+  gem "jeweler"
   gem 'guard'
   gem 'guard-rspec'
   gem 'webmock'
+  gem 'dotenv'
   gem 'vcr'
+  gem 'redis'
 end
 
 gem 'httparty'
 gem 'json'
-gem 'hashie'
+gem 'hashie'

data/Gemfile.lock

@@ -9,6 +9,7 @@ GEM
     crack (0.4.2)
       safe_yaml (~> 1.0.0)
     diff-lcs (1.1.3)
+    dotenv (1.0.2)
     faraday (0.8.9)
       multipart-post (~> 1.2.0)
     ffi (1.9.3)
@@ -72,6 +73,7 @@ GEM
       ffi (>= 0.5.0)
     rdoc (3.12.2)
       json (~> 1.4)
+    redis (3.1.0)
     rspec (2.8.0)
       rspec-core (~> 2.8.0)
       rspec-expectations (~> 2.8.0)
@@ -94,13 +96,15 @@ PLATFORMS
 
 DEPENDENCIES
   bundler
+  dotenv
   guard
   guard-rspec
   hashie
   httparty
-  jeweler (~> 1.8.3)
+  jeweler
   json
-  rdoc (~> 3.12)
-  rspec (~> 2.8.0)
+  rdoc
+  redis
+  rspec
   vcr
   webmock

data/README.rdoc

@@ -2,22 +2,81 @@
 
 Ruby API wrapper to Capital IQ API.
 
+== Compatibility Warning
+
+Breaking changes were introduced in versions following v0.0.7. This was necessary to provide support for new features such as multi-identifier/multi-mnemonic calls.
+
+v0.0.7 design is no longer maintained and can be found here: https://github.com/exitround/capital-iq/tree/v0.0.7
 
 == Installation
 
   gem install capital-iq
-  
 
-== Usage
+== Capital IQ API Basics
 
-  client = CapitalIQ::Base.new('user@host.com', 'sfd98j429ds')
-  => #<CapitalIQ::Base:0x007fd81d41ac38 @auth={:username=>"user@host.com", :password=>"sfd98j429ds"}>
-  
-  client.quick_match('exitround')
-  => "IQ231729634"
-  
-  client.gdsp_request('IQ231729634', 'IQ_CITY')
-  => "San Francisco" 
+Each request to Capital IQ API contains three required parameters: function, identifier, mnemonic, and one optional parameter: properties. The corresponding result will contain a rowset with "headers" and "rows". For single-value mnemonics the result would usually consist of a single header and a single row. The header name would usually match the name of the input mnemonic. Multi-value mnemonics, however, often contain additional headers (such as "change date" etc) and multiple rows.
+
+Please refer to Capital IQ support and documentation for specific function/mnemonic instructions and data retrieval pricing information.
+
+== Gem Usage
+
+To start, initialize the client object with the user name and password. This example assumes that they are stored in the environment variables:
+  client = CapitalIQ::Client.new(ENV['CAPIQ_USER'], ENV['CAPIQ_PWD'])
+
+=== API Calls Based on Request Objects
+
+This is the most basic way of using the gem. Create a request, call the api, get the result. Here, the function is GDSHE, the identifier is 'microsoft' and the mnemonic is IQ_COMPANY_ID_QUICK_MATCH:
+
+  req = CapitalIQ::Request.new(CapitalIQ::Functions::GDSHE, 'microsoft', 'IQ_COMPANY_ID_QUICK_MATCH')
+  res = client.base_request(req)
+
+
+You have an option of passing multiple requst objects into a call. They are all executed in one round trip. Beware of the API limits however.
+
+  req1 = CapitalIQ::Request.new(CapitalIQ::Functions::GDSHE, 'microsoft', 'IQ_COMPANY_ID_QUICK_MATCH')
+  req2 = CapitalIQ::Request.new(CapitalIQ::Functions::GDSHE, 'google', 'IQ_COMPANY_ID_QUICK_MATCH')
+  res = client.base_request([req1, req2])
+
+=== Convenience Methods - request_xxxxx
+
+You may choose to use the convenience methods provided by the +Client+ class - +request_xxxxx+, where xxxxx - is the name of Capital IQ API function). They allow to forgo creating the request objects explicity, (the requsts objects do get created underneath though):
+
+  res = client.request_gdshe('microsoft', 'IQ_COMPANY_ID_QUICK_MATCH', {startRank:1, endRank:20})
+
+The returned values are accessed by the identifier and the header name:
+
+  res_val = res['microsoft']['IQ_COMPANY_ID_QUICK_MATCH']
+
+When using GDSHE or GDSHV functions, the result is represented by an array. Therefore +res_val+ above is an array. We'll use +first+ method to get the actual value:
+
+  ms_id = res_val.first
+
+You can use the +scalar+ method when querying on a single identifier, so the above example can be shortened to:
+
+  ms_id = res.scalar['IQ_COMPANY_ID_QUICK_MATCH'].first
+
+=== Multiple identifier / single mnemonic requests
+
+This example generates two requests:
+
+  res = client.request_gdshe(['microsoft', 'google'], 'IQ_COMPANY_ID_QUICK_MATCH', {startRank:1, endRank:20})
+  ms_id = res['microsoft']['IQ_COMPANY_ID_QUICK_MATCH'].first
+  google_id = res['google']['IQ_COMPANY_ID_QUICK_MATCH'].first
+
+=== Multiple identifier / multiple mnemonic queries
+
+This call generates (2 identifiers times 3 mnemonics) = 6 requests (they're still executed in a batch)
+
+  res = client.request_gdsp([ms_id, google_id], %w(IQ_COMPANY_WEBSITE IQ_COMPANY_NAME IQ_BUSINESS_DESCRIPTION))
+
+You can use the +to_hash+ method to retrieve all values for a given identifier
+
+  # All values for +ms_id+
+  ms_data = res[ms_id].to_hash
+
+Or you can retrieve all values for all identifiers:
+
+  all_data = res.to_hash
   
 
 == Contributing to capital-iq

data/Rakefile

@@ -15,12 +15,12 @@ require 'jeweler'
 Jeweler::Tasks.new do |gem|
   # gem is a Gem::Specification... see http://docs.rubygems.org/read/chapter/20 for more options
   gem.name = "capital-iq"
-  gem.homepage = "http://github.com/seeingidog/capital-iq"
+  gem.homepage = "http://github.com/exitround/capital-iq"
   gem.license = "MIT"
   gem.summary = %Q{Ruby wrapper for the CapIQ API}
   gem.description = %Q{Ruby wrapper for the CapIQ API}
-  gem.email = "ian@ruby-code.com"
-  gem.authors = ["Ian Morgan"]
+  gem.email = "dev@exitround.com"
+  gem.authors = ["Val Savvateev", "Greg Dean"]
   # dependencies defined in Gemfile
 end
 Jeweler::RubygemsDotOrgTasks.new

data/VERSION

@@ -1 +1 @@
-0.0.7
+0.0.11

data/capital-iq.gemspec

@@ -2,17 +2,18 @@
 # DO NOT EDIT THIS FILE DIRECTLY
 # Instead, edit Jeweler::Tasks in Rakefile, and run 'rake gemspec'
 # -*- encoding: utf-8 -*-
-# stub: capital-iq 0.0.7 ruby lib
+# stub: capital-iq 0.0.11 ruby lib
 
 Gem::Specification.new do |s|
   s.name = "capital-iq"
-  s.version = "0.0.7"
+  s.version = "0.0.11"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
-  s.authors = ["Ian Morgan"]
-  s.date = "2014-10-10"
+  s.require_paths = ["lib"]
+  s.authors = ["Val Savvateev", "Greg Dean"]
+  s.date = "2015-02-24"
   s.description = "Ruby wrapper for the CapIQ API"
-  s.email = "ian@ruby-code.com"
+  s.email = "dev@exitround.com"
   s.extra_rdoc_files = [
     "LICENSE.txt",
     "README.rdoc"
@@ -27,19 +28,18 @@ Gem::Specification.new do |s|
     "VERSION",
     "capital-iq.gemspec",
     "lib/capital-iq.rb",
-    "lib/capital-iq/api-error.rb",
-    "lib/capital-iq/base.rb",
+    "lib/capital-iq/api_error.rb",
+    "lib/capital-iq/api_response.rb",
+    "lib/capital-iq/cache.rb",
+    "lib/capital-iq/client.rb",
+    "lib/capital-iq/functions.rb",
     "lib/capital-iq/request.rb",
-    "lib/capital-iq/transaction.rb",
-    "spec/capital-iq_spec.rb",
-    "spec/request_spec.rb",
-    "spec/responses/capiq_ibm.json",
-    "spec/spec_helper.rb"
+    "lib/capital-iq/request_result.rb",
+    "spec/capital-iq_spec.rb"
   ]
-  s.homepage = "http://github.com/seeingidog/capital-iq"
+  s.homepage = "http://github.com/exitround/capital-iq"
   s.licenses = ["MIT"]
-  s.require_paths = ["lib"]
-  s.rubygems_version = "2.1.11"
+  s.rubygems_version = "2.4.5"
   s.summary = "Ruby wrapper for the CapIQ API"
 
   if s.respond_to? :specification_version then
@@ -49,39 +49,45 @@ Gem::Specification.new do |s|
       s.add_runtime_dependency(%q<httparty>, [">= 0"])
       s.add_runtime_dependency(%q<json>, [">= 0"])
       s.add_runtime_dependency(%q<hashie>, [">= 0"])
-      s.add_development_dependency(%q<rspec>, ["~> 2.8.0"])
-      s.add_development_dependency(%q<rdoc>, ["~> 3.12"])
+      s.add_development_dependency(%q<rspec>, [">= 0"])
+      s.add_development_dependency(%q<rdoc>, [">= 0"])
       s.add_development_dependency(%q<bundler>, [">= 0"])
-      s.add_development_dependency(%q<jeweler>, ["~> 1.8.3"])
+      s.add_development_dependency(%q<jeweler>, [">= 0"])
       s.add_development_dependency(%q<guard>, [">= 0"])
       s.add_development_dependency(%q<guard-rspec>, [">= 0"])
       s.add_development_dependency(%q<webmock>, [">= 0"])
+      s.add_development_dependency(%q<dotenv>, [">= 0"])
       s.add_development_dependency(%q<vcr>, [">= 0"])
+      s.add_development_dependency(%q<redis>, [">= 0"])
     else
       s.add_dependency(%q<httparty>, [">= 0"])
       s.add_dependency(%q<json>, [">= 0"])
       s.add_dependency(%q<hashie>, [">= 0"])
-      s.add_dependency(%q<rspec>, ["~> 2.8.0"])
-      s.add_dependency(%q<rdoc>, ["~> 3.12"])
+      s.add_dependency(%q<rspec>, [">= 0"])
+      s.add_dependency(%q<rdoc>, [">= 0"])
       s.add_dependency(%q<bundler>, [">= 0"])
-      s.add_dependency(%q<jeweler>, ["~> 1.8.3"])
+      s.add_dependency(%q<jeweler>, [">= 0"])
       s.add_dependency(%q<guard>, [">= 0"])
       s.add_dependency(%q<guard-rspec>, [">= 0"])
       s.add_dependency(%q<webmock>, [">= 0"])
+      s.add_dependency(%q<dotenv>, [">= 0"])
       s.add_dependency(%q<vcr>, [">= 0"])
+      s.add_dependency(%q<redis>, [">= 0"])
     end
   else
     s.add_dependency(%q<httparty>, [">= 0"])
     s.add_dependency(%q<json>, [">= 0"])
     s.add_dependency(%q<hashie>, [">= 0"])
-    s.add_dependency(%q<rspec>, ["~> 2.8.0"])
-    s.add_dependency(%q<rdoc>, ["~> 3.12"])
+    s.add_dependency(%q<rspec>, [">= 0"])
+    s.add_dependency(%q<rdoc>, [">= 0"])
     s.add_dependency(%q<bundler>, [">= 0"])
-    s.add_dependency(%q<jeweler>, ["~> 1.8.3"])
+    s.add_dependency(%q<jeweler>, [">= 0"])
     s.add_dependency(%q<guard>, [">= 0"])
     s.add_dependency(%q<guard-rspec>, [">= 0"])
     s.add_dependency(%q<webmock>, [">= 0"])
+    s.add_dependency(%q<dotenv>, [">= 0"])
     s.add_dependency(%q<vcr>, [">= 0"])
+    s.add_dependency(%q<redis>, [">= 0"])
   end
 end
 

data/lib/capital-iq.rb

@@ -1,9 +1,17 @@
+require 'set'
+require 'ostruct'
 require 'httparty'
 require 'json'
-require_relative 'capital-iq/base'
-require_relative 'capital-iq/request'
-require_relative 'capital-iq/api-error'
-require_relative 'capital-iq/transaction'
+require 'digest'
+require 'zlib'
 
 module CapitalIQ
 end
+
+require_relative 'capital-iq/cache'
+require_relative 'capital-iq/functions'
+require_relative 'capital-iq/api_error'
+require_relative 'capital-iq/request'
+require_relative 'capital-iq/request_result'
+require_relative 'capital-iq/api_response'
+require_relative 'capital-iq/client'

data/lib/capital-iq/api_error.rb

@@ -0,0 +1,4 @@
+module CapitalIQ
+  class ApiError < StandardError
+  end
+end

data/lib/capital-iq/api_response.rb

@@ -0,0 +1,73 @@
+module CapitalIQ
+  class ApiResponse
+    class IdentifierResultGroup
+      attr_reader :identifier
+      def initialize(identifier)
+        @identifier = identifier
+        @header_map = {}
+        @results = []
+      end
+      def <<(result)
+        raise "Result contains wrong identifier" if result.Identifier != self.identifier
+        @results << result
+        (result.Headers || []).each { |h| @header_map[h] = result }
+      end
+      def headers
+        @header_map.keys
+      end
+
+      def [](header)
+        @header_map[header][header]
+      end
+
+      def to_hash
+        Hash[self.headers.collect { |h| [h, self[h]] }]
+      end
+
+      def to_s
+        to_hash().to_s()
+      end
+    end
+
+    def initialize(response_data)
+      @response_data = response_data
+
+      @results = []
+      @identifier_results = Hash.new {|hash, key| hash[key] = IdentifierResultGroup.new(key)}
+      raw_results = response_data["GDSSDKResponse"]
+      return if !raw_results.is_a?(Array)
+
+      # create wrappers for each response
+      @results = raw_results.collect { |r| RequestResult.new(r) }
+      # build a map from header to corresponding result wrappers
+      @results.each { |r| @identifier_results[r.Identifier] << r }
+    end
+
+    def has_errors?(header=nil)
+      return true if @response_data.include?("Errors")
+      @results.find { |r| r.has_errors?(header)}
+    end
+
+    def [](identifier)
+      return nil unless @identifier_results.has_key?(identifier)
+      @identifier_results[identifier]
+    end
+
+    def scalar
+      return nil if @identifier_results.length == 0
+      @identifier_results.first[1]
+    end
+
+    def identifiers
+      @identifier_results.keys
+    end
+
+    def to_hash
+      Hash[self.identifiers.collect { |id| [id, self[id]] }]
+    end
+
+    def to_s
+      to_hash().to_s()
+    end
+  end
+end

data/lib/capital-iq/cache.rb

@@ -0,0 +1,89 @@
+module CapitalIQ
+  class Cache
+
+    def initialize(store, prefix)
+      @store = store
+      @prefix = prefix
+    end
+
+    ##
+    # Read from the Cache.
+    #
+    def [](url)
+      interpret case
+        when store.respond_to?(:[])
+          store[key_for(url)]
+        when store.respond_to?(:get)
+          store.get key_for(url)
+        when store.respond_to?(:read)
+          store.read key_for(url)
+      end
+    end
+
+    ##
+    # Write to the Cache.
+    #
+    def []=(url, value)
+      case
+        when store.respond_to?(:[]=)
+          store[key_for(url)] = value
+        when store.respond_to?(:set)
+          store.set key_for(url), value
+        when store.respond_to?(:write)
+          store.write key_for(url), value
+      end
+    end
+
+    ##
+    # Delete cache entry for given URL,
+    # or pass <tt>:all</tt> to clear all URLs.
+    #
+    def expire(url)
+      if url == :all
+        urls.each{ |u| expire(u) }
+      else
+        expire_single_url(url)
+      end
+    end
+
+
+    private # ----------------------------------------------------------------
+
+    attr_reader :prefix, :store
+
+    ##
+    # Cache key for a given URL.
+    #
+    def key_for(url)
+      [prefix, url].join
+    end
+
+    ##
+    # Array of keys with the currently configured prefix
+    # that have non-nil values.
+    #
+    def keys
+      store.keys.select{ |k| k.match /^#{prefix}/ and interpret(store[k]) }
+    end
+
+    ##
+    # Array of cached URLs.
+    #
+    def urls
+      keys.map{ |k| k[/^#{prefix}(.*)/, 1] }
+    end
+
+    ##
+    # Clean up value before returning. Namely, convert empty string to nil.
+    # (Some key/value stores return empty string instead of nil.)
+    #
+    def interpret(value)
+      value == "" ? nil : value
+    end
+
+    def expire_single_url(url)
+      key = key_for(url)
+      store.respond_to?(:del) ? store.del(key) : store.delete(key)
+    end
+  end
+end

data/lib/capital-iq/client.rb

@@ -0,0 +1,78 @@
+module CapitalIQ
+  class Client
+    attr_reader :cache
+
+    ENDPOINT = 'https://sdk.gds.standardandpoors.com/gdssdk/rest/v2/clientservice.json'
+    include HTTParty
+    format :json
+
+    def initialize(username, password, cache_store=nil, cache_prefix="CAPIQ_")
+      @auth = {username: username, password: password}
+      @cache = Cache.new(cache_store, cache_prefix)
+    end
+
+    def base_request(requests)
+      # build request
+      requests = [requests] unless requests.class == Array
+      request_array = requests.collect { |r| r.to_hash }
+      request_body = {inputRequests: {inputRequests: request_array}.to_json}
+
+      # send request
+      response_data = from_cache(request_body) || self.class.post(
+          ENDPOINT, body: request_body, basic_auth: @auth, ssl_version: :SSLv3
+      ).parsed_response
+
+      # analyze response
+      response = ApiResponse.new(response_data)
+      raise ApiError if response.has_errors?
+      to_cache(request_body, response_data)
+      response
+    end
+
+    def request(function, identifiers, mnemonics, properties=nil)
+      mnemonics = [mnemonics] unless mnemonics.is_a? Enumerable
+      identifiers = [identifiers] unless identifiers.is_a? Enumerable
+      requests = []
+      identifiers.each do |identifier|
+        requests.unshift(*mnemonics.collect {|m| CapitalIQ::Request.new(function, identifier, m, properties)})
+      end
+      base_request(requests)
+    end
+
+    def method_missing(meth, *args, &block)
+      if meth.to_s =~ /^request_(.+)$/
+        function = $1.upcase
+        if Functions.all.include?(function)
+          request(*([function]+args))
+        else
+          super
+        end
+      else
+        super
+      end
+    end
+
+    private
+
+    def to_cache(request_body, response_data)
+      return if @cache.nil?
+      @cache[cache_key(request_body)] = Zlib::Deflate.deflate(response_data.to_json)
+    end
+
+    def from_cache(request_body)
+      return nil if @cache.nil?
+      result = @cache[cache_key(request_body)]
+      return nil if result.nil?
+      JSON.parse(Zlib::Inflate.inflate(result))
+    end
+
+    def cache_key(request_body)
+      Digest::MD5.hexdigest(request_body.to_s)
+    end
+
+  end
+
+  # b/w compatibility with 0.07
+
+  Base = Client
+end

data/lib/capital-iq/functions.rb

@@ -0,0 +1,21 @@
+module CapitalIQ
+  class Functions
+    GDSP ||= 'GDSP'
+    GDSPV ||= 'GDSPV'
+    GDSG ||= 'GDSG'
+    GDSHE ||= 'GDSHE'
+    GDSHV ||= 'GDSHV'
+    GDST ||= 'GDST'
+
+    @all ||= Set.new([GDSP,GDSPV,GDSG,GDSHE,GDSHV,GDST])
+
+    class << self
+
+      attr_reader :all
+
+      def is_array_function(function)
+        function == GDSHE || function == GDSHV
+      end
+    end
+  end
+end

data/lib/capital-iq/request.rb

@@ -1,14 +1,24 @@
 module CapitalIQ
   class Request
-    attr_reader :request
-    
-    def initialize(function, identifier, mnemonic, properties)
-      request_hash =  {inputRequests:[
-        {function:function, identifier: identifier, mnemonic: mnemonic}
-      ]}
-      request_hash.merge!({properties: properties}) if properties
-      @request = "inputRequests=" + request_hash.to_json
+    attr_reader :function, :identifier, :mnemonic, :properties
+
+    def initialize(function, identifier, mnemonic, properties = nil)
+      @function = function
+      @identifier = identifier
+      @mnemonic = mnemonic
+      @properties = properties
+
+      @hash = {
+          function: self.function,
+          identifier: self.identifier,
+          mnemonic: self.mnemonic
+      }
+      @hash[:properties] = properties unless properties.nil?
     end
-    
+
+    def to_hash
+      @hash
+    end
+
   end
 end

data/lib/capital-iq/request_result.rb

@@ -0,0 +1,28 @@
+module CapitalIQ
+  class RequestResult < OpenStruct
+    def initialize(raw_result)
+      @raw_result = raw_result
+      super raw_result
+    end
+
+    def has_errors?(header=nil)
+      !self.ErrMsg.nil? && (header.nil? || header.in?(self.Headers))
+    end
+
+    def [](header)
+      result = value_array(header)
+      return result if Functions.is_array_function(self.Function)
+      result.first
+    end
+
+    private
+    def value_array(header)
+      header_idx = self.Headers.index(header)
+      raise ArgumentError, "Unknown header '#{header}'" if header_idx.nil?
+      self.Rows.collect do |row|
+        v = row["Row"][header_idx]
+        v == 'Data Unavailable' ? nil : v
+      end
+    end
+  end
+end

data/spec/capital-iq_spec.rb

@@ -1,7 +1,50 @@
-require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+require 'webmock/rspec'
+require 'vcr'
+require 'dotenv'
+
+require File.expand_path(File.dirname(__FILE__) + '/../lib/capital-iq.rb')
+
+Dotenv.load
+
+VCR.configure do |c|
+  c.cassette_library_dir = 'spec/vcr_cassettes'
+  c.hook_into :webmock
+end
 
 describe "CapitalIq" do
-  it "fails" do
-    fail "hey buddy, you should probably rename this file and start specing for real"
+  VCR.use_cassette("spec") do
+    client = CapitalIQ::Client.new(ENV['CAPIQ_USER'], ENV['CAPIQ_PWD'])
+
+    # Call based on a request object
+    # All requests passed to the base_request method are executed withing one roundtrip
+    req1 = CapitalIQ::Request.new(CapitalIQ::Functions::GDSHE, 'microsoft', 'IQ_COMPANY_ID_QUICK_MATCH')
+    req2 = CapitalIQ::Request.new(CapitalIQ::Functions::GDSHE, 'google', 'IQ_COMPANY_ID_QUICK_MATCH')
+    res = client.base_request([req1, req2])
+
+    # Shortened form - no need to create request objects explicitly, although they do get created underneath:
+    res = client.request_gdshe('microsoft', 'IQ_COMPANY_ID_QUICK_MATCH', {startRank:1, endRank:20})
+
+    # Returned values are accessed by identifier and mnemonic:
+    res_val = res['microsoft']['IQ_COMPANY_ID_QUICK_MATCH']
+
+    # When using GDSHE or GDSHV, the result is represented by an array (so we'll use 'first' here)
+    ms_id = res_val.first
+
+    # You can use 'scalar' when querying on a single identifier, so we can shorten the whole thing to:
+    ms_id = res.scalar['IQ_COMPANY_ID_QUICK_MATCH'].first
+
+    # Multiple identifier / single mnemonic requests
+    # This example generates two requests
+    res = client.request_gdshe(['microsoft', 'google'], 'IQ_COMPANY_ID_QUICK_MATCH', {startRank:1, endRank:20})
+    ms_id = res['microsoft']['IQ_COMPANY_ID_QUICK_MATCH'].first
+    google_id = res['google']['IQ_COMPANY_ID_QUICK_MATCH'].first
+
+    # Multiple identifier / multiple mnemonic queries
+    # This call generates (2 identifiers times 3 mnemonics) = 6 requests (they're still executed in a batch)
+    res = client.request_gdsp([ms_id, google_id], %w(IQ_COMPANY_WEBSITE IQ_COMPANY_NAME IQ_BUSINESS_DESCRIPTION))
+    # You can use the 'to_hash' method to retrieve all mnemonic values for a given identifier
+    ms_data = res[ms_id].to_hash # all mnemonics for ms_id
+    # Or you can retrieve all values for all identifiers
+    google_data = res[google_id].to_hash # all mnemonics for google_id
   end
 end

metadata

@@ -1,14 +1,15 @@
 --- !ruby/object:Gem::Specification
 name: capital-iq
 version: !ruby/object:Gem::Version
-  version: 0.0.7
+  version: 0.0.11
 platform: ruby
 authors:
-- Ian Morgan
+- Val Savvateev
+- Greg Dean
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-10-10 00:00:00.000000000 Z
+date: 2015-02-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: httparty
@@ -56,30 +57,30 @@ dependencies:
   name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - ! '>='
       - !ruby/object:Gem::Version
-        version: 2.8.0
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - ! '>='
       - !ruby/object:Gem::Version
-        version: 2.8.0
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rdoc
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - ! '>='
       - !ruby/object:Gem::Version
-        version: '3.12'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - ! '>='
       - !ruby/object:Gem::Version
-        version: '3.12'
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -98,16 +99,16 @@ dependencies:
   name: jeweler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - ! '>='
       - !ruby/object:Gem::Version
-        version: 1.8.3
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - ! '>='
       - !ruby/object:Gem::Version
-        version: 1.8.3
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: guard
   requirement: !ruby/object:Gem::Requirement
@@ -150,6 +151,20 @@ dependencies:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: dotenv
+  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: vcr
   requirement: !ruby/object:Gem::Requirement
@@ -164,8 +179,22 @@ dependencies:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: redis
+  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: Ruby wrapper for the CapIQ API
-email: ian@ruby-code.com
+email: dev@exitround.com
 executables: []
 extensions: []
 extra_rdoc_files:
@@ -181,15 +210,15 @@ files:
 - VERSION
 - capital-iq.gemspec
 - lib/capital-iq.rb
-- lib/capital-iq/api-error.rb
-- lib/capital-iq/base.rb
+- lib/capital-iq/api_error.rb
+- lib/capital-iq/api_response.rb
+- lib/capital-iq/cache.rb
+- lib/capital-iq/client.rb
+- lib/capital-iq/functions.rb
 - lib/capital-iq/request.rb
-- lib/capital-iq/transaction.rb
+- lib/capital-iq/request_result.rb
 - spec/capital-iq_spec.rb
-- spec/request_spec.rb
-- spec/responses/capiq_ibm.json
-- spec/spec_helper.rb
-homepage: http://github.com/seeingidog/capital-iq
+homepage: http://github.com/exitround/capital-iq
 licenses:
 - MIT
 metadata: {}
@@ -209,7 +238,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.1.11
+rubygems_version: 2.4.5
 signing_key: 
 specification_version: 4
 summary: Ruby wrapper for the CapIQ API

data/lib/capital-iq/api-error.rb

@@ -1,4 +0,0 @@
-module CapitalIQ
-  class APIError < StandardError
-  end
-end

data/lib/capital-iq/base.rb

@@ -1,77 +0,0 @@
-module CapitalIQ
-  class Base
-    ENDPOINT = 'https://sdk.gds.standardandpoors.com/gdssdk/rest/v2/clientservice.json'
-    include HTTParty
-    format :json
-
-    def initialize(username, password)
-      @auth = {username: username, password: password}
-    end
-
-    def request(function, identifier, mnemonic, properties)
-      request_body = Request.new(function, identifier, mnemonic, properties).request
-      response_data = self.class.post(ENDPOINT, body: request_body, basic_auth: @auth, ssl_version: :SSLv3).parsed_response
-      response = response_data[response_data.keys.first]
-      raise CapitalIQ::APIError if response == "Error Processing the Request"
-      raise CapitalIQ::APIError, response.first['ErrMsg'] if response.first['ErrMsg']
-      response.first
-    end
-
-    def gdst_request(identifier, mnemonic)
-      response = request('GDST', identifier, mnemonic, {PERIODTYPE: "IQ_FQ"})
-      response['Rows'].first['Row'].first
-    end
-
-    def gdsp_request(identifier, mnemonic)
-      response = request('GDSP', identifier, mnemonic, nil)
-      response['Rows'].first['Row'].first
-    end
-
-    def gdshe_request(identifier, mnemonic, properties)
-      response = request('GDSHE', identifier, mnemonic, properties)
-      response['Rows'].first['Row'].first
-    end
-
-    def quick_match(name)
-      gdshe_request(name, 'IQ_COMPANY_ID_QUICK_MATCH', {startRank:"1", endRank:"5"})
-    end
-
-    def match_and_request(name, mnemonic)
-      identifier = quick_match(name)
-      gdsp_request(identifier, mnemonic)
-    end
-
-    def transaction_list(identifier)
-      transaction_items = ['IQ_TR_CURRENCY', 'IQ_TR_TARGET_ID', 'IQ_TR_BUYER_ID', 'IQ_TR_SELLER_ID', 'IQ_TR_STATUS', 'IQ_TR_CLOSED_DATE', 'IQ_TR_IMPLIED_EV_FINAL']
-      walk_transactions(identifier, 'IQ_TRANSACTION_LIST_MA', transaction_items)
-    end
-
-    def pe_transactions(identifier)
-      transaction_items = ['IQ_PRIMARY_SIC_CODE', 'IQ_EMPLOYEES']
-      walk_transactions(identifier, 'IQ_INVESTMENTS_ALL_ID', transaction_items)
-    end
-
-    private
-     def walk_transactions(identifier, list_identifier, transaction_items)
-      acquisitions = {}
-      transaction_list = request('GDSHE', identifier, list_identifier, {startRank:"1", endRank:"20"})
-      return nil if transaction_list['Rows'].first["Row"].first == 'Data Unavailable'
-      transaction_list['Rows'].each do |transaction|
-        acquisitions[transaction['Row'].first] = transaction_items.map {|transaction_item|
-          Hash[transaction_item, request('GDSP', transaction['Row'].first, transaction_item, nil)['Rows'].map {|a|
-            next if a['Row'].first == 'Data Unavailable'
-            if a['Row'].first.include?(',')
-              a['Row'].first.split(', ')
-            else
-              a['Row'].first
-            end
-            }.first 
-          ]
-        }.reduce({}, :merge)
-      end
-      acquisitions
-
-     end
-
-  end
-end

data/lib/capital-iq/transaction.rb

@@ -1,8 +0,0 @@
-module CapitalIQ
-  class Transaction
-    
-    def initialize
-    end
-    
-  end    
-end

data/spec/request_spec.rb

@@ -1,7 +0,0 @@
-require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
-
-describe "CapitalIQ Request" do
-  it "fails" do
-    fail "hey buddy, you should probably rename this file and start specing for real"
-  end
-end

data/spec/spec_helper.rb

@@ -1,22 +0,0 @@
-$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
-$LOAD_PATH.unshift(File.dirname(__FILE__))
-require 'rspec'
-require 'capital-iq'
-require 'webmock/rspec'
-require 'vcr'
-
-# Requires supporting files with custom matchers and macros, etc,
-# in ./support/ and its subdirectories.
-Dir["#{File.dirname(__FILE__)}/support/**/*.rb"].each {|f| require f}
-
-RSpec.configure do |config|
-  
-end
-
-WebMock.disable_net_connect!
-WebMock.stub_request(:post. "https://sdk.gds.standardandpoors.com/gdssdk/rest/v2/clientservice.json").to_return(:status => 200, :body => File.new(File.dirname(__FILE__) + '/responses/capiq_ibm.json'), :headers => {})
-
-VCR.config do |c|
-  c.cassette_library_dir = 'spec/fixtures/dish_cassettes'
-  c.stub_with :webmock
-end