caller_id 0.0.1

data/Gemfile

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

data/Gemfile.lock

@@ -0,0 +1,37 @@
+PATH
+  remote: .
+  specs:
+    caller_id (0.0.1)
+      json
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    addressable (2.2.8)
+    crack (0.3.1)
+    diff-lcs (1.1.3)
+    json (1.6.1)
+    rspec (2.10.0)
+      rspec-core (~> 2.10.0)
+      rspec-expectations (~> 2.10.0)
+      rspec-mocks (~> 2.10.0)
+    rspec-core (2.10.1)
+    rspec-expectations (2.10.0)
+      diff-lcs (~> 1.1.3)
+    rspec-mocks (2.10.1)
+    timecop (0.3.5)
+    vcr (2.2.2)
+    webmock (1.8.6)
+      addressable (>= 2.2.7)
+      crack (>= 0.1.7)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (>= 1.0.0)
+  caller_id!
+  rspec (~> 2.6)
+  timecop (~> 0.3)
+  vcr (~> 2.1)
+  webmock (= 1.8.6)

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2012 Ben Ellis
+
+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,54 @@
+# CallerId
+
+A ruby wrapper around OpenCNAM api. Lookup cell phone caller ID in supported countries. See http://docs.opencnam.com/#what-s-our-coverage
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'caller_id'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install caller_id
+
+## Usage
+
+    c = CallerId::ReversePhoneLookup "+1 (202) 456-1414", open_cnam_username, open_cnam_api_key
+    # Username and key are optional. Sign up at http://opencnam.com to get them.
+    c.lookup
+    # {:cnam => "WHITE HOUSE SWI", :number => "2024561414"}
+
+Note: if a number has not yet been mapped by OpenCNAM, you'll get a response containing :retry => true (see the spec).
+
+In that case you should wait a few seconds and then try the call again. You may want to do this in a background queue.
+
+Also note, the "cnam" value returned by a successful lookup is just a caller id string, all caps, with varying semantics.
+
+I've seen:
+* [first last]
+* [last first]
+* [last, first middle]
+
+If you do need to parse it into first and last name, be aware that the string format varies wildly. One possible
+approach would be to do this:
+
+    first_and_maybe_middle_initial, last = result[:cname].split(",",2).reverse.join(" ").split(" ",2)
+
+But be warned that this will not always parse them correctly, and that in some cases the string returned might not even be a name
+(see the White House example). You might want to treat it as a "best guess" that should then be confirmed via other sources.
+
+If you do not sign up for a username and API key with OpenCNAM, be aware that they currently throttle free requests to 60 per hour.
+Also note the username and API keys will soon be associated with a price plan.
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Added some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1,20 @@
+#!/usr/bin/env rake
+require "bundler/gem_tasks"
+require 'rake'
+require 'rspec/core/rake_task'
+
+task :default  => :spec
+
+
+desc "Run specs"
+RSpec::Core::RakeTask.new do |t|
+  t.pattern = "./spec/**/*_spec.rb" # don't need this, it's default.
+  # Put spec opts in a file named .rspec in root
+end
+
+desc "Generate code coverage"
+RSpec::Core::RakeTask.new(:coverage) do |t|
+  t.pattern = "./spec/**/*_spec.rb" # don't need this, it's default.
+  t.rcov = true
+  t.rcov_opts = ['--exclude', 'spec']
+end

data/caller_id.gemspec

@@ -0,0 +1,26 @@
+# -*- encoding: utf-8 -*-
+require File.expand_path('../lib/caller_id/version', __FILE__)
+
+Gem::Specification.new do |gem|
+  gem.authors       = ["Ben Ellis"]
+  gem.email         = ["bellis@on-site.com"]
+  gem.description   = %q{Ruby wrapper for OpenCNAM}
+  gem.summary       = %q{Do reverse phone lookups via OpenCNAM ( http://www.opencnam.com/ )}
+  gem.homepage      = "https://github.com/on-site/caller_id"
+
+  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          = "caller_id"
+  gem.require_paths = ["lib"]
+  gem.version       = CallerId::VERSION
+
+  gem.add_development_dependency "bundler", ">= 1.0.0"
+  gem.add_development_dependency "rspec", "~> 2.6"
+  gem.add_development_dependency "vcr", "~> 2.1"
+  gem.add_development_dependency "webmock", "1.8.6"
+  gem.add_development_dependency "timecop", "~> 0.3"
+
+  gem.add_dependency "json"
+
+end

data/lib/caller_id.rb

@@ -0,0 +1,38 @@
+require "caller_id/version"
+require "json"
+require "open-uri"
+
+module CallerId
+  # This class leverages the OpenCNAM service to lookup names from phone numbers.
+  # http://docs.opencnam.com/guide.html
+  class ReversePhoneLookup
+    def initialize number, user = nil, key = nil
+      @phone_number = number.to_s.gsub(/\D/,'').gsub(/\A1/,'') # strip spaces, punctuation, and leading 1s.
+      # TODO: consider raising a specific Exception here.
+      raise "invalid format" if @phone_number.nil? || @phone_number.strip.empty? || @phone_number.length != 10
+      if user && key
+        @api_user = user
+        @api_key  = key
+      end
+    end
+    # Derived from https://github.com/EricR/sinatra-cnam-lookup/blob/master/cnam_checker.rb
+    def lookup
+      begin
+        response = open(get_url)
+      rescue OpenURI::HTTPError
+        return {:not_found => true}
+      end
+      return {:retry => true, :now => Time.now} if response.status[0] == "202"
+      return if response.status[0] != "200"
+      json_response = response.read
+      results = JSON.parse(json_response)
+      {:cnam => results["cnam"].strip, :number => results["number"]}
+    end
+    private
+    def get_url
+      url = "https://api.opencnam.com/v1/phone/#{@phone_number}?format=json"
+      url += "&username=#{@api_user}&api_key=#{@api_key}" if @api_user && @api_key
+      url
+    end
+  end
+end

data/lib/caller_id/version.rb

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

data/spec/caller_id_spec.rb

@@ -0,0 +1,41 @@
+require 'spec_helper'
+require 'caller_id'
+
+describe CallerId do
+  let(:white_house_num) { "2024561414" }
+  let(:white_house_lookup_response) { {:cnam => "WHITE HOUSE SWI", :number => white_house_num} }
+  let(:kevin_brower) { "(510) 883-1085"}
+  let(:not_found) { "5034871414" }
+  let(:now) { Time.now }
+  describe "#lookup" do
+    use_vcr_cassette
+    it "returns name" do
+      CallerId::ReversePhoneLookup.new(white_house_num).lookup.should == white_house_lookup_response
+    end
+    it "ignores leading 1" do
+      CallerId::ReversePhoneLookup.new("1#{white_house_num}").lookup.should == white_house_lookup_response
+    end
+    it "ignores anything other than numbers" do
+      CallerId::ReversePhoneLookup.new("+1(#{white_house_num})...").lookup.should == white_house_lookup_response
+    end
+  end
+  describe "#lookup uncached number" do
+    use_vcr_cassette
+    it "returns retry" do
+      Timecop.freeze(now) do
+        CallerId::ReversePhoneLookup.new(kevin_brower).lookup.should == {:retry => true, :now => now}
+      end
+    end
+  end
+  describe "#lookup unlisted number" do
+    use_vcr_cassette
+    it "returns not found" do
+      CallerId::ReversePhoneLookup.new(not_found).lookup.should == {:not_found => true}
+    end
+  end
+  describe "#lookup invalid number" do
+    it "raises an error before even trying the lookup" do
+      expect { CallerId::ReversePhoneLookup.new("foo") }.to raise_error
+    end
+  end
+end

data/spec/cassettes/CallerId/_lookup.yml

@@ -0,0 +1,34 @@
+--- 
+http_interactions: 
+- request: 
+    method: get
+    uri: https://api.opencnam.com/v1/phone/2024561414?format=json
+    body: 
+      encoding: US-ASCII
+      string: ""
+    headers: 
+      Accept: 
+      - "*/*"
+      User-Agent: 
+      - Ruby
+  response: 
+    status: 
+      code: 200
+      message: OK
+    headers: 
+      Content-Type: 
+      - application/json; charset=utf-8
+      Date: 
+      - Mon, 18 Jun 2012 10:19:24 GMT
+      Server: 
+      - gunicorn/0.14.2
+      Content-Length: 
+      - "51"
+      Connection: 
+      - keep-alive
+    body: 
+      encoding: US-ASCII
+      string: "{\"cnam\": \"WHITE HOUSE SWI\", \"number\": \"2024561414\"}"
+    http_version: 
+  recorded_at: Mon, 18 Jun 2012 10:19:25 GMT
+recorded_with: VCR 2.2.2

data/spec/cassettes/CallerId/_lookup_uncached_number.yml

@@ -0,0 +1,34 @@
+--- 
+http_interactions: 
+- request: 
+    method: get
+    uri: https://api.opencnam.com/v1/phone/5108831085?format=json
+    body: 
+      encoding: US-ASCII
+      string: ""
+    headers: 
+      Accept: 
+      - "*/*"
+      User-Agent: 
+      - Ruby
+  response: 
+    status: 
+      code: 202
+      message: ACCEPTED
+    headers:
+      Content-Type:
+      - text/html; charset=utf-8
+      Date:
+      - Fri, 15 Jun 2012 15:09:25 GMT
+      Server:
+      - gunicorn/0.14.2
+      Content-Length:
+      - '86'
+      Connection:
+      - keep-alive
+    body: 
+      encoding: US-ASCII
+      string: Currently running a lookup for phone '5108831085'. Please check back in a few seconds.
+    http_version: 
+  recorded_at: Fri, 15 Jun 2012 15:09:25 GMT
+recorded_with: VCR 2.2.2

data/spec/cassettes/CallerId/_lookup_unlisted_number.yml

@@ -0,0 +1,34 @@
+--- 
+http_interactions: 
+- request: 
+    method: get
+    uri: https://api.opencnam.com/v1/phone/5034871414?format=json
+    body: 
+      encoding: US-ASCII
+      string: ""
+    headers: 
+      Accept: 
+      - "*/*"
+      User-Agent: 
+      - Ruby
+  response: 
+    status: 
+      code: 404
+      message: NOT FOUND
+    headers: 
+      Content-Type: 
+      - text/html; charset=utf-8
+      Date: 
+      - Mon, 18 Jun 2012 10:19:27 GMT
+      Server: 
+      - gunicorn/0.14.2
+      Content-Length: 
+      - "0"
+      Connection: 
+      - keep-alive
+    body: 
+      encoding: US-ASCII
+      string: ""
+    http_version: 
+  recorded_at: Mon, 18 Jun 2012 10:19:28 GMT
+recorded_with: VCR 2.2.2

data/spec/spec_helper.rb

@@ -0,0 +1,12 @@
+require 'timecop'
+require 'vcr'
+
+VCR.configure do |c|
+  c.cassette_library_dir     = 'spec/cassettes'
+
+  c.hook_into                  :webmock
+end
+
+RSpec.configure do |config|
+  config.extend VCR::RSpec::Macros
+end

metadata

@@ -0,0 +1,129 @@
+--- !ruby/object:Gem::Specification
+name: caller_id
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Ben Ellis
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-06-18 00:00:00.000000000Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: &2153249760 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 1.0.0
+  type: :development
+  prerelease: false
+  version_requirements: *2153249760
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: &2153249140 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.6'
+  type: :development
+  prerelease: false
+  version_requirements: *2153249140
+- !ruby/object:Gem::Dependency
+  name: vcr
+  requirement: &2153248560 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.1'
+  type: :development
+  prerelease: false
+  version_requirements: *2153248560
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: &2153247980 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - =
+      - !ruby/object:Gem::Version
+        version: 1.8.6
+  type: :development
+  prerelease: false
+  version_requirements: *2153247980
+- !ruby/object:Gem::Dependency
+  name: timecop
+  requirement: &2153247400 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.3'
+  type: :development
+  prerelease: false
+  version_requirements: *2153247400
+- !ruby/object:Gem::Dependency
+  name: json
+  requirement: &2153246920 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *2153246920
+description: Ruby wrapper for OpenCNAM
+email:
+- bellis@on-site.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- Gemfile
+- Gemfile.lock
+- LICENSE
+- README.md
+- Rakefile
+- caller_id.gemspec
+- lib/caller_id.rb
+- lib/caller_id/version.rb
+- spec/caller_id_spec.rb
+- spec/cassettes/CallerId/_lookup.yml
+- spec/cassettes/CallerId/_lookup_uncached_number.yml
+- spec/cassettes/CallerId/_lookup_unlisted_number.yml
+- spec/spec_helper.rb
+homepage: https://github.com/on-site/caller_id
+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.11
+signing_key: 
+specification_version: 3
+summary: Do reverse phone lookups via OpenCNAM ( http://www.opencnam.com/ )
+test_files:
+- spec/caller_id_spec.rb
+- spec/cassettes/CallerId/_lookup.yml
+- spec/cassettes/CallerId/_lookup_uncached_number.yml
+- spec/cassettes/CallerId/_lookup_unlisted_number.yml
+- spec/spec_helper.rb