cik 0.0.1 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 0235e9a80f3c3421a119d34ba0d9c2bca9d658e4
-  data.tar.gz: 9d09de49176462ee21f217d112af3a7e3ce2f671
+  metadata.gz: 64ee71ff81ed6397be64de20cc6a7fa22e6fc37e
+  data.tar.gz: 1677df5928aeeb4997e806c91e169d5c2306df9e
 SHA512:
-  metadata.gz: 57f5590480367c5d3c8d2e393b3e0b2a87f1a5111731a5ca3a00792f20768b766f9d6244f3b9a3b93bfb51ff7c757c773fec99c9e7507ff3249ee84771034b0c
-  data.tar.gz: 011a56babedb5131b8885e90d7149d0471d709004a160fc0c63d7acd54cd4b99ec434b9f64ca60c4222362bf04927ffcf1f13b17f893b7e51286090cdfbd565b
+  metadata.gz: 71459c5054dd662f15ae4bf9e6c2292e17da1fb17fbf5fe243eaf3d568250d6f3724a76ad027f90cddb2e7b827447ec9a74b95fe85815f614960b27af6b1a700
+  data.tar.gz: 3be2e1b8cd39aa5aea846463cbb7e720263dace9e8a146d605dbc9f3c234c0553704e1bde5f594b1d05b7105852bfe9c51d4fa8d3b50bb6a9899a9adbbd69ad6

data/.rspec

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

data/.travis.yml

@@ -0,0 +1,4 @@
+language: ruby
+rvm:
+  - "2.1.3"
+script: bundle exec rspec spec

data/README.md

@@ -1,6 +1,10 @@
 # Cik
 
-TODO: Write a gem description
+A Central Index Key or CIK number is a number given to an individual or company by the [United States Securities and
+Exchange Commission (SEC)](http://www.sec.gov). The number is used to identify the filings of a company in the [EDGAR
+database](http://www.sec.gov/edgar/searchedgar/companysearch.html).
+
+This gem allows to look up the EDGAR database by symbol to get the company CIK.
 
 ## Installation
 
@@ -18,12 +22,47 @@ Or install it yourself as:
 
 ## Usage
 
-TODO: Write usage instructions here
+Usage is pretty simple:
+
+```ruby
+Cik.lookup('CSCO')
+```
+
+The response is a Hash with this format:
+
+```ruby
+{
+  :cik => "0000858877",
+  :name => "CISCO SYSTEMS, INC.",
+  :sic => "3576"
+}
+```
+
+| Key       | Description |
+| ----------| ----------- |
+| cik       | CIK number  |
+| name      | Entity name |
+| sic       | SIC (Standard Industrial Classification) code |
 
 ## Contributing
 
-1. Fork it ( http://github.com/<my-github-username>/cik/fork )
+1. Fork it ( http://github.com/javiervidal/cik/fork )
 2. Create your feature branch (`git checkout -b my-new-feature`)
 3. Commit your changes (`git commit -am 'Add some feature'`)
 4. Push to the branch (`git push origin my-new-feature`)
 5. Create new Pull Request
+
+## Code Status
+
+[![Gem Version](https://badge.fury.io/rb/cik.svg)](http://badge.fury.io/rb/cik)
+[![Build Status](https://travis-ci.org/javiervidal/cik.svg?branch=master)](https://travis-ci.org/javiervidal/cik)
+[![Coverage Status](https://coveralls.io/repos/javiervidal/cik/badge.png?branch=master)](https://coveralls.io/r/javiervidal/cik?branch=master)
+[![Code Climate](https://codeclimate.com/github/javiervidal/cik/badges/gpa.svg)](https://codeclimate.com/github/javiervidal/cik)
+
+## Copyright
+
+Copyright (c) 2014 – ∞ Javier Vidal
+
+## License
+
+This gem is released under the [MIT License](http://opensource.org/licenses/MIT).

data/Rakefile

@@ -1 +1,10 @@
 require "bundler/gem_tasks"
+
+task :console do
+  require "awesome_print"
+  require "irb"
+  require "irb/completion"
+  require "cik"
+  ARGV.clear
+  IRB.start
+end

data/cik.gemspec

@@ -20,4 +20,10 @@ Gem::Specification.new do |spec|
 
   spec.add_development_dependency "bundler", "~> 1.5"
   spec.add_development_dependency "rake"
+  spec.add_development_dependency "awesome_print"
+  spec.add_development_dependency "rspec"
+  spec.add_development_dependency "simplecov"
+  spec.add_development_dependency "webmock"
+  spec.add_development_dependency "coveralls"
+  spec.add_runtime_dependency "nokogiri"
 end

data/lib/cik.rb

@@ -1,5 +1,2 @@
-require "cik/version"
-
-module Cik
-  # Your code goes here...
-end
+require 'cik/version'
+require 'cik/cik'

data/lib/cik/cik.rb

@@ -0,0 +1,38 @@
+class Cik
+
+  require 'open-uri'
+  require 'nokogiri'
+
+  class << self
+
+    def lookup(symbol)
+      doc = Nokogiri::HTML(open(edgar_lookup_url(symbol)))
+      md = /(.+)\sCIK#:\s(\d{10})/.match(company_info(doc))
+      if md
+        {
+          cik: md[2],
+          name: md[1],
+          sic: sic(doc)
+        }
+      else
+        nil
+      end
+    end
+
+    def edgar_lookup_url(symbol)
+      "http://www.sec.gov/cgi-bin/browse-edgar?CIK=#{symbol}&action=getcompany"
+    end
+
+    def company_info(doc)
+      doc.css("div.companyInfo").css("span.companyName").text
+    end
+
+    def sic(doc)
+      doc.css("p.identInfo a")[0].text
+    end
+
+  end
+
+  private_class_method :edgar_lookup_url, :edgar_lookup_url, :sic
+
+end

data/lib/cik/version.rb

@@ -1,3 +1,3 @@
-module Cik
-  VERSION = "0.0.1"
-end
+class Cik
+  VERSION = "1.0.0"
+end

data/spec/cik/cik_spec.rb

@@ -0,0 +1,37 @@
+require 'spec_helper'
+
+describe Cik do
+
+  describe '.lookup' do
+
+    context 'when a valid symbol is looked up' do
+
+      let(:entity) { Cik.lookup('CSCO') }
+
+      it 'returns a cik' do
+        expect(entity[:cik]).to eq('0000858877')
+      end
+
+      it 'returns an entity name' do
+        expect(entity[:name]).to eq('CISCO SYSTEMS, INC.')
+      end
+
+      it 'returns a sic' do
+        expect(entity[:sic]).to eq('3576')
+      end
+
+    end
+
+    context 'when an invalid symbol is looked up' do
+
+      let(:entity) { Cik.lookup('ZZZZ') }
+
+      it 'returns nil' do
+        expect(entity).to be_nil
+      end
+
+    end
+
+  end
+
+end

data/spec/fixtures/csco.html

@@ -0,0 +1,6 @@
+<div class="companyInfo">
+    <span class="companyName">CISCO SYSTEMS, INC. <acronym title="Central Index Key">CIK</acronym>#: <a href="/cgi-bin/browse-edgar?action=getcompany&amp;CIK=0000858877&amp;owner=include&amp;count=40">0000858877 (see all company filings)</a></span>
+    <p class="identInfo"><acronym title="Standard Industrial Code">SIC</acronym>: <a href="/cgi-bin/browse-edgar?action=getcompany&amp;SIC=3576&amp;owner=include&amp;count=40">3576</a> - COMPUTER COMMUNICATIONS EQUIPMENT<br />State location: <a href="/cgi-bin/browse-edgar?action=getcompany&amp;State=CA&amp;owner=include&amp;count=40">CA</a> | State of Inc.: <strong>CA</strong> | Fiscal Year End: 0728<br />formerly: CISCO SYSTEMS INC (filings through 2011-11-22)<br />(Assistant Director Office: 3)<br />Get <a href="/cgi-bin/own-disp?action=getissuer&amp;CIK=0000858877"><b>insider transactions</b></a> for this <b>issuer</b>.
+        <br />Get <a href="/cgi-bin/own-disp?action=getowner&amp;CIK=0000858877"><b>insider transactions</b></a> for this <b>reporting owner</b>.
+    </p>
+</div>

data/spec/spec_helper.rb

@@ -0,0 +1,44 @@
+require 'simplecov'
+SimpleCov.start
+
+require 'coveralls'
+Coveralls.wear!
+
+
+require 'cik'
+require 'webmock/rspec'
+
+# 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
+RSpec.configure do |config|
+  config.run_all_when_everything_filtered = true
+  config.filter_run :focus
+
+  # Run specs in random order to surface order dependencies. If you find an
+  # order dependency and want to debug it, you can fix the order by providing
+  # the seed, which is printed after each run.
+  #     --seed 1234
+  config.order = 'random'
+
+  config.before(:each) do
+    stub_request(:get, "http://www.sec.gov/cgi-bin/browse-edgar?CIK=CSCO&action=getcompany").
+      with(:headers => {'Accept' => '*/*'}).
+      to_return(:status => 200, :body => fixture('csco.html'), :headers => {})
+    stub_request(:get, "http://www.sec.gov/cgi-bin/browse-edgar?CIK=ZZZZ&action=getcompany").
+      with(:headers => {'Accept' => '*/*'}).
+      to_return(:status => 200, :body => "", :headers => {})
+  end
+
+end
+
+def fixture_path
+  File.expand_path('../fixtures', __FILE__)
+end
+
+def fixture(file)
+  File.new(fixture_path + '/' + file)
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: cik
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 1.0.0
 platform: ruby
 authors:
 - Javier Vidal
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-11-26 00:00:00.000000000 Z
+date: 2014-11-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -38,6 +38,90 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: awesome_print
+  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: rspec
+  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: simplecov
+  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: webmock
+  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: coveralls
+  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: nokogiri
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 description: CIK lookup in EDGAR database
 email:
 - javier@javiervidal.net
@@ -46,13 +130,19 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".gitignore"
+- ".rspec"
+- ".travis.yml"
 - Gemfile
 - LICENSE.txt
 - README.md
 - Rakefile
 - cik.gemspec
 - lib/cik.rb
+- lib/cik/cik.rb
 - lib/cik/version.rb
+- spec/cik/cik_spec.rb
+- spec/fixtures/csco.html
+- spec/spec_helper.rb
 homepage: ''
 licenses:
 - MIT
@@ -77,4 +167,7 @@ rubygems_version: 2.2.2
 signing_key: 
 specification_version: 4
 summary: CIK lookup in EDGAR database
-test_files: []
+test_files:
+- spec/cik/cik_spec.rb
+- spec/fixtures/csco.html
+- spec/spec_helper.rb