tickerizer 0.0.1 → 0.0.2

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (7) hide show
  1. data/.travis.yml +6 -0
  2. data/README.md +8 -4
  3. data/Rakefile +4 -0
  4. data/lib/tickerizer/version.rb +1 -1
  5. data/spec/spec_helper.rb +1 -1
  6. data/tickerizer.gemspec +1 -0
  7. metadata +20 -8
data/.travis.yml ADDED
@@ -0,0 +1,6 @@
1
+ language: ruby
2
+ gemfile: Gemfile
3
+ rvm:
4
+ - "1.9.2"
5
+ - "1.9.3"
6
+ - "2.0.0"
data/README.md CHANGED
@@ -1,6 +1,10 @@
1
1
  # Tickerizer
2
2
 
3
- Tickerizer extracts company names and stock symbols from content strings.
3
+ Use Tickerizer to extract company names and stock symbols from content strings.
4
+
5
+ [![Build Status](https://travis-ci.org/JimMayes/tickerizer.png?branch=master)](https://travis-ci.org/JimMayes/tickerizer)
6
+ [![Code Climate](https://codeclimate.com/github/JimMayes/tickerizer.png)](https://codeclimate.com/github/JimMayes/tickerizer)
7
+ [![Gem Version](https://badge.fury.io/rb/tickerizer.png)](http://badge.fury.io/rb/tickerizer)
4
8
 
5
9
  ## Requirements
6
10
 
@@ -24,7 +28,7 @@ $ gem install tickerizer
24
28
  ```
25
29
 
26
30
  ## Configuration
27
- Provide your OenCalais API Key in familiar config block fashion
31
+ Provide your OpenCalais API Key in familiar config block fashion
28
32
  ```ruby
29
33
  Tickerizer.configure do |config|
30
34
  config.license_id = 'YOUR_API_KEY_HERE'
@@ -35,7 +39,7 @@ end
35
39
 
36
40
  ### Extracting Company Information
37
41
 
38
- 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
42
+ Provide a string of content to Tickerizer's extract method and it will return an array containing the company references found.
39
43
 
40
44
  ```ruby
41
45
  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?"
@@ -45,7 +49,7 @@ companies = Tickerizer.extract(content)
45
49
  #=> [{:name=>"Microsoft", :relevance=>0.667, :ticker=>"MSFT", :symbol=>"MSFT.OQ"}, {:name=>"Ford", :relevance=>0.476, :ticker=>"F", :symbol=>"F.N"}]
46
50
  ```
47
51
 
48
- It is therefore, non-trivial to retrieve a "primary ticker" (most relevant) for the provided content string
52
+ Results are ordered by their semantic relevance to the content string. Therefore, it is trivial to retrieve a "primary ticker" (most relevant) for the provided content string
49
53
 
50
54
  ```ruby
51
55
  companies.first[:ticker]
data/Rakefile CHANGED
@@ -1,2 +1,6 @@
1
1
  #!/usr/bin/env rake
2
2
  require "bundler/gem_tasks"
3
+
4
+ require 'rspec/core/rake_task'
5
+ RSpec::Core::RakeTask.new(:spec)
6
+ task :default => :spec
data/lib/tickerizer/version.rb CHANGED
@@ -1,3 +1,3 @@
1
1
  module Tickerizer
2
- VERSION = "0.0.1"
2
+ VERSION = "0.0.2"
3
3
  end
data/spec/spec_helper.rb CHANGED
@@ -5,5 +5,5 @@
5
5
  #
6
6
  # See http://rubydoc.info/gems/rspec-core/RSpec/Core/Configuration
7
7
  #
8
- require 'Tickerizer'
8
+ require './lib/tickerizer'
9
9
  require 'json'
data/tickerizer.gemspec CHANGED
@@ -12,6 +12,7 @@ Gem::Specification.new do |gem|
12
12
  gem.add_dependency "json"
13
13
 
14
14
  gem.add_development_dependency "rspec"
15
+ gem.add_development_dependency "rake"
15
16
 
16
17
  gem.files = `git ls-files`.split($\)
17
18
  gem.executables = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
metadata CHANGED
@@ -1,7 +1,7 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: tickerizer
3
3
  version: !ruby/object:Gem::Version
4
- version: 0.0.1
4
+ version: 0.0.2
5
5
  prerelease:
6
6
  platform: ruby
7
7
  authors:
@@ -9,11 +9,11 @@ authors:
9
9
  autorequire:
10
10
  bindir: bin
11
11
  cert_chain: []
12
- date: 2013-10-07 00:00:00.000000000 Z
12
+ date: 2013-10-08 00:00:00.000000000 Z
13
13
  dependencies:
14
14
  - !ruby/object:Gem::Dependency
15
15
  name: calais
16
- requirement: &70175413746700 !ruby/object:Gem::Requirement
16
+ requirement: &70213550833640 !ruby/object:Gem::Requirement
17
17
  none: false
18
18
  requirements:
19
19
  - - ! '>='
@@ -21,10 +21,10 @@ dependencies:
21
21
  version: '0'
22
22
  type: :runtime
23
23
  prerelease: false
24
- version_requirements: *70175413746700
24
+ version_requirements: *70213550833640
25
25
  - !ruby/object:Gem::Dependency
26
26
  name: json
27
- requirement: &70175413750400 !ruby/object:Gem::Requirement
27
+ requirement: &70213550831000 !ruby/object:Gem::Requirement
28
28
  none: false
29
29
  requirements:
30
30
  - - ! '>='
@@ -32,10 +32,10 @@ dependencies:
32
32
  version: '0'
33
33
  type: :runtime
34
34
  prerelease: false
35
- version_requirements: *70175413750400
35
+ version_requirements: *70213550831000
36
36
  - !ruby/object:Gem::Dependency
37
37
  name: rspec
38
- requirement: &70175413726720 !ruby/object:Gem::Requirement
38
+ requirement: &70213550842900 !ruby/object:Gem::Requirement
39
39
  none: false
40
40
  requirements:
41
41
  - - ! '>='
@@ -43,7 +43,18 @@ dependencies:
43
43
  version: '0'
44
44
  type: :development
45
45
  prerelease: false
46
- version_requirements: *70175413726720
46
+ version_requirements: *70213550842900
47
+ - !ruby/object:Gem::Dependency
48
+ name: rake
49
+ requirement: &70213550839840 !ruby/object:Gem::Requirement
50
+ none: false
51
+ requirements:
52
+ - - ! '>='
53
+ - !ruby/object:Gem::Version
54
+ version: '0'
55
+ type: :development
56
+ prerelease: false
57
+ version_requirements: *70213550839840
47
58
  description: Parses content and extras stock tickers for companies mentioned
48
59
  email:
49
60
  - jim.mayes@gmail.com
@@ -53,6 +64,7 @@ extra_rdoc_files: []
53
64
  files:
54
65
  - .gitignore
55
66
  - .rspec
67
+ - .travis.yml
56
68
  - Gemfile
57
69
  - LICENSE
58
70
  - README.md