opencnam 0.0.1

data/lib/opencnam.rb

@@ -0,0 +1,79 @@
+require "net/http"
+
+require "opencnam/version"
+require "opencnam/util"
+require "opencnam/errors/opencnam_error"
+require "opencnam/errors/bad_request_error"
+require "opencnam/errors/invalid_phone_number_error"
+require "opencnam/errors/no_info_error"
+require "opencnam/errors/running_lookup_error"
+require "opencnam/errors/throttled_error"
+
+module OpenCNAM
+  @@api_base = 'https://api.opencnam.com'
+  @@api_user = nil
+  @@api_key  = nil
+
+  def self.api_user=(api_user)
+    @@api_user = api_user
+  end
+
+  def self.api_key=(api_key)
+    @@api_key = api_key
+  end
+
+  def self.lookup(number)
+    # Clean phone number
+    clean_number = OpenCNAM::Util.clean_phone_number(number)
+
+    # Build query
+    query = URI.encode_www_form(
+      :format => 'text',
+      :username => @@api_user,
+      :api_key => @@api_key,
+    )
+
+    # Send request
+    uri = URI.parse(@@api_base)
+    http = Net::HTTP.new(uri.host, uri.port)
+    http.use_ssl = true
+
+    res = http.request_get("/v1/phone/#{clean_number}?#{query}")
+
+    # 200 - OK
+    if res.kind_of?(Net::HTTPOK)
+      return {
+        :name => res.body,
+        :number => clean_number,
+      }
+    end
+
+    error_attrs = {
+      :http_status => res.code,
+      :message => res.message,
+    }
+
+    # 202 - Currently running a lookup for phone number
+    if res.kind_of?(Net::HTTPAccepted)
+      raise RunningLookupError.new(error_attrs)
+    end
+
+    # 403 - Forbidden, requests throttled
+    if res.kind_of?(Net::HTTPForbidden)
+      raise ThrottledError.new(error_attrs)
+    end
+
+    # 400 - Bad request
+    if res.kind_of?(Net::HTTPBadRequest)
+      raise BadRequestError.new(error_attrs)
+    end
+
+    # 404 - No caller ID name information
+    if res.kind_of?(Net::HTTPNotFound)
+      raise NoInfoError.new(error_attrs)
+    end
+
+    # Unkown response
+    raise OpenCNAMError.new(error_attrs)
+  end
+end

data/lib/opencnam/errors/bad_request_error.rb

@@ -0,0 +1,4 @@
+module OpenCNAM
+  class BadRequestError < OpenCNAMError
+  end
+end

data/lib/opencnam/errors/invalid_phone_number_error.rb

@@ -0,0 +1,7 @@
+module OpenCNAM
+  class InvalidPhoneNumberError < OpenCNAMError
+    def initialize(phone_number)
+      super(:message => "#{phone_number} could not be parsed as a valid US phone number")
+    end
+  end
+end

data/lib/opencnam/errors/no_info_error.rb

@@ -0,0 +1,4 @@
+module OpenCNAM
+  class NoInfoError < OpenCNAMError
+  end
+end

data/lib/opencnam/errors/opencnam_error.rb

@@ -0,0 +1,18 @@
+module OpenCNAM
+  class OpenCNAMError < StandardError
+    attr_reader :message
+    attr_reader :http_status
+    attr_reader :http_body
+
+    def initialize(opts = {})
+      @message = opts[:message] || nil
+      @http_status = opts[:http_status] || nil
+      @http_body = opts[:http_body] || nil
+    end
+
+    def to_s
+      status = @http_status.nil? ? "" : "(Status #{@http_status}) "
+      "#{status}#{@message}"
+    end
+  end
+end

data/lib/opencnam/errors/running_lookup_error.rb

@@ -0,0 +1,4 @@
+module OpenCNAM
+  class RunningLookupError < OpenCNAMError
+  end
+end

data/lib/opencnam/errors/throttled_error.rb

@@ -0,0 +1,4 @@
+module OpenCNAM
+  class ThrottledError < OpenCNAMError
+  end
+end

data/lib/opencnam/util.rb

@@ -0,0 +1,14 @@
+module OpenCNAM
+  module Util
+    def self.clean_phone_number(number)
+      # Drop all characters except integers
+      clean_number = number.to_s
+      clean_number.tr!('^0-9', '')
+      clean_number = clean_number[-10..-1]
+
+      raise InvalidPhoneNumberError.new(number) if !clean_number || clean_number.length < 10
+
+      clean_number
+    end
+  end
+end

data/lib/opencnam/version.rb

@@ -0,0 +1,3 @@
+module OpenCNAM
+  VERSION = '0.0.1'
+end

metadata

@@ -0,0 +1,102 @@
+--- !ruby/object:Gem::Specification
+name: opencnam
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Nysa Vann
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-06-21 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: fakeweb
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 3.1.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 3.1.0
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: OpenCNAM provides a simple, elegant, and RESTful API to get Caller ID
+  data.
+email: nysa@nysavann.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/opencnam/errors/bad_request_error.rb
+- lib/opencnam/errors/invalid_phone_number_error.rb
+- lib/opencnam/errors/no_info_error.rb
+- lib/opencnam/errors/opencnam_error.rb
+- lib/opencnam/errors/running_lookup_error.rb
+- lib/opencnam/errors/throttled_error.rb
+- lib/opencnam/util.rb
+- lib/opencnam/version.rb
+- lib/opencnam.rb
+homepage: http://github.com/nysa/ruby-opencnam
+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.22
+signing_key: 
+specification_version: 3
+summary: Ruby bindings for the OpenCNAM API
+test_files: []