tickerizer 0.0.1

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--format progress

data/Gemfile

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

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2013 jimmayes
+
+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,53 @@
+# Tickerizer
+
+Tickerizer extracts company names and stock symbols from content strings.
+
+## Requirements
+
+An OpenCalais account is required to make use of this gem. Create your account and request an API key at http://www.opencalais.com/APIkey
+
+## Installation
+
+Add this line to your application's Gemfile:
+```
+gem 'tickerizer'
+```
+
+And then execute:
+```
+$ bundle
+```
+
+Or install it yourself as:
+```
+$ gem install tickerizer
+```
+
+## Configuration
+Provide your OenCalais API Key in familiar config block fashion
+```ruby
+Tickerizer.configure do |config|
+	config.license_id = 'YOUR_API_KEY_HERE'
+end
+```
+
+## Usage
+
+### Extracting Company Information
+
+Provide a string of content to Tickerizer's extract method and it will return any array containing the company references found ordered by their semantic relevance to the content string
+
+```ruby
+content = "Ford CEO Alan Mulally is reportedly among the names being discussed by Microsoft's board of directors as a successor to Steve Ballmer, who'll be retiring within a year. Would such a move make sense for Microsoft?"
+
+companies = Tickerizer.extract(content)
+
+#=> [{:name=>"Microsoft", :relevance=>0.667, :ticker=>"MSFT", :symbol=>"MSFT.OQ"}, {:name=>"Ford", :relevance=>0.476, :ticker=>"F", :symbol=>"F.N"}]
+```
+
+It is therefore, non-trivial to retrieve a "primary ticker" (most relevant) for the provided content string
+
+```ruby
+companies.first[:ticker]
+#=> "MSFT"
+```

data/Rakefile

@@ -0,0 +1,2 @@
+#!/usr/bin/env rake
+require "bundler/gem_tasks"

data/lib/tickerizer/version.rb

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

data/lib/tickerizer.rb

@@ -0,0 +1,54 @@
+require "tickerizer/version"
+
+module Tickerizer
+	class Configuration
+		attr_accessor :license_id
+
+		def initialize
+			self.license_id = nil
+		end
+	end
+
+	def self.configuration
+		@configuration ||= Configuration.new
+	end
+
+	def self.configure
+		yield(configuration) if block_given?
+	end
+
+	class << self
+		attr_accessor :license_id
+
+		def license_id
+	    	raise "OpenCalais License ID is required" unless @license_id
+	    	@license_id
+	    end
+	end
+
+	def self.extract(content)
+		resp = Calais.enlighten(
+			:content => content,
+			:content_type => :raw,
+			:output_format => :json,
+			:license_id => Tickerizer.configuration.license_id
+		)
+
+		self.process( JSON.parse(resp) )
+	end
+
+	def self.process(data)
+		companies = Array.new
+
+		data.each do |node|
+			if node[1]["_type"] == "Company"
+				company = {:name => node[1]["name"], :relevance => node[1]["relevance"].to_f}
+				company[:ticker] = node[1]["resolutions"][0]["ticker"] if node[1]["resolutions"]
+
+				companies << company
+			end
+		end
+
+		companies.sort_by{|company| company[:relevance]}.reverse!
+	end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,9 @@
+# This file was generated by the `rspec --init` command. Conventionally, all
+# specs live under a `spec` directory, which RSpec adds to the `$LOAD_PATH`.
+# Require this file using `require "spec_helper"` to ensure that it is only
+# loaded once.
+#
+# See http://rubydoc.info/gems/rspec-core/RSpec/Core/Configuration
+# 
+require 'Tickerizer'
+require 'json'

data/spec/tickerizer_spec.rb

@@ -0,0 +1,28 @@
+require 'spec_helper'
+
+describe Tickerizer do
+	context "has a response" do
+		# Test parser against expected format
+		
+		# example OpenCalais response for "Google, Inc"
+		data = JSON.parse("{\"doc\":{\"info\":{\"calaisRequestID\":\"4a3565f4-4180-e419-1419-02b26a32c0b3\",\"id\":\"http://id.opencalais.com/LvyWK4U7P6xyJEGM1u9mew\",\"docId\":\"http://d.opencalais.com/dochash-1/835e8fef-a4e4-3b91-89af-6060372f215b\",\"document\":\"Google, Inc\",\"docTitle\":\"\",\"docDate\":\"2013-10-06 18:47:29.169\"},\"meta\":{\"contentType\":\"text/raw\",\"emVer\":\"7.1.1103.5\",\"langIdVer\":\"DefaultLangId\",\"processingVer\":\"CalaisJob01\",\"submissionDate\":\"2013-10-06 18:47:29.059\",\"submitterCode\":\"8ff5522d-bcb1-c039-11e2-4512df0dcbd9\",\"signature\":\"digestalg-1|6cRb/b8lNBNmGWvmnJfUzVqYEGg=|EqIXLG3DYFkjtLYC8Ga1ILuTHmN/i06L+DVAHC4mRPxXJGlzcB8ARQ==\",\"language\":\"InputTextTooShort\"}},\"http://d.opencalais.com/dochash-1/835e8fef-a4e4-3b91-89af-6060372f215b/lid/DefaultLangId\":{\"_typeGroup\":\"language\",\"language\":\"http://d.opencalais.com/lid/DefaultLangId/InputTextTooShort\"},\"http://d.opencalais.com/comphash-1/230b96d5-1757-3e7f-8e8b-e81f7861a91a\":{\"_typeGroup\":\"entities\",\"_type\":\"Company\",\"name\":\"Google Inc\",\"nationality\":\"N/A\",\"_typeReference\":\"http://s.opencalais.com/1/type/em/e/Company\",\"instances\":[{\"detection\":\"[]Google, Inc[]\",\"exact\":\"Google, Inc\",\"offset\":0,\"length\":11}],\"relevance\":0.857,\"resolutions\":[{\"id\":\"http://d.opencalais.com/er/company/ralg-tr1r/ce181d44-1915-3387-83da-0dc4ec01c6da\",\"score\":1,\"name\":\"GOOGLE INC.\",\"shortname\":\"Google\",\"ticker\":\"GOOG\",\"symbol\":\"GOOG.OQ\"}]}}")
+
+		it "should retrieve company name" do
+			name = Tickerizer.process( data ).first[:name]
+
+			name.should eq("Google Inc")
+		end
+
+		it "should retrieve a relevance score" do
+			relevance = Tickerizer.process( data ).first[:relevance]
+
+			relevance.should eq(0.857)
+		end
+
+		it "should retrieve stock ticker" do
+			ticker = Tickerizer.process( data ).first[:ticker]
+
+			ticker.should eq("GOOG")
+		end
+	end
+end

data/tickerizer.gemspec

@@ -0,0 +1,22 @@
+# -*- encoding: utf-8 -*-
+require File.expand_path('../lib/tickerizer/version', __FILE__)
+
+Gem::Specification.new do |gem|
+  gem.authors       = ["jimmayes"]
+  gem.email         = ["jim.mayes@gmail.com"]
+  gem.description   = %q{Parses content and extras stock tickers for companies mentioned}
+  gem.summary       = %q{Parse content for stock tickers}
+  gem.homepage      = ""
+
+  gem.add_dependency "calais"
+  gem.add_dependency "json"
+
+  gem.add_development_dependency "rspec"
+
+  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.name          = "tickerizer"
+  gem.require_paths = ["lib"]
+  gem.version       = Tickerizer::VERSION
+end

metadata

@@ -0,0 +1,91 @@
+--- !ruby/object:Gem::Specification
+name: tickerizer
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- jimmayes
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-10-07 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: calais
+  requirement: &70175413746700 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *70175413746700
+- !ruby/object:Gem::Dependency
+  name: json
+  requirement: &70175413750400 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *70175413750400
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: &70175413726720 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *70175413726720
+description: Parses content and extras stock tickers for companies mentioned
+email:
+- jim.mayes@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- lib/tickerizer.rb
+- lib/tickerizer/version.rb
+- spec/spec_helper.rb
+- spec/tickerizer_spec.rb
+- tickerizer.gemspec
+homepage: ''
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.10
+signing_key: 
+specification_version: 3
+summary: Parse content for stock tickers
+test_files:
+- spec/spec_helper.rb
+- spec/tickerizer_spec.rb