prolenea 0.1.3

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 9b033eef5b018688e6f6db15fa6f31a4ad2bca7b
+  data.tar.gz: 98d60848c9065075acbe086c97e4496f3049ac4e
+SHA512:
+  metadata.gz: f78d1bf61a29c579dd43b1225a90fc0c4a75136eb2ce0c9543edbb9514192cbbebc9d50fe3ded1afa7fb378654e576a5b2598ebdc71c598644b71f2ef6367e41
+  data.tar.gz: 1e30bc25f72bab38bb6a81bce0e05b7c4d27b771c061837af2c79b6e3e41c2957fcbb333074614894041da6955efa0fa3e6d99af19ba915cc6da405e787885e7

data/.gitignore

@@ -0,0 +1,13 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+/*.gem
+
+# rspec failure tracking
+.rspec_status

data/.rspec

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

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.3.3
+before_install: gem install bundler -v 1.14.6

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2018 Keith Larrimore
+
+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

@@ -0,0 +1 @@
+

data/README.md

@@ -0,0 +1,64 @@
+# Prolenea
+
+## Installation
+
+```bash
+$ gem install prolenea
+```
+
+## Usage
+
+### CLI Usage
+
+```bash
+$ prolenea-client -u http://prolenea.example.com -n 12125551000
+```
+
+### Ruby Usage
+
+```ruby
+require 'prolenea'
+
+options = {}
+options[:uri] = 'http://prolenea.example.com'
+number = '12125551000'
+
+Prolenea.connect options
+
+result = Prolenea.lookup_number number
+
+puts JSON.pretty_generate result
+```
+
+### Output
+
+```javascript
+{
+  "number": "2125551000",
+  "local_routing_number": null,
+  "ported_date": null,
+  "alternative_spid": null,
+  "alternative_spid_name": null,
+  "line_type": null,
+  "operating_company_number": "MULT",
+  "operating_company_name": "MULTIPLE OCN LISTING",
+  "lata": "99999",
+  "city": "CUSTOMER DIRECTORY ASSISTANCE",
+  "state": "NY"
+}
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/klarrimore/prolenea.
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,6 @@
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/prolenea-client

@@ -0,0 +1,34 @@
+#!/usr/bin/env ruby
+
+require 'bundler/setup'
+require 'optparse'
+require 'pry'
+require 'prolenea'
+
+include Prolenea
+
+options, config = {}, {}
+
+OptionParser.new do |opts|
+  opts.on("-u", "--uri URI", String, "Prolenea URI") do |uri|
+    options[:uri] = uri
+  end
+
+  opts.on("-n", "--number Number", String, "Number to lookup") do |number|
+    options[:number] = number
+  end
+end.parse!
+
+begin
+  config[:uri] = options[:uri]
+  number = options[:number]
+
+  Prolenea.connect config
+
+  result = Prolenea.lookup_number number
+
+  puts JSON.pretty_generate result
+rescue ProleneaError => pe
+  STDERR.puts pe.message
+  STDERR.puts pe.backtrace.join("\n")
+end

data/lib/prolenea.rb

@@ -0,0 +1,38 @@
+require 'faraday'
+require 'json'
+require 'prolenea/version'
+require 'prolenea/errors'
+require 'prolenea/connection'
+require 'prolenea/middleware/prolenea_response_middleware'
+
+module Prolenea
+  include Error
+
+  module ClassMethods
+
+    def connection
+      @connection ? @connection : (raise StandardError)
+    end
+
+    def connect(config = {})
+      @connection = Connection.new(:uri => config[:uri])
+    end
+
+    def lookup_number(number)
+      params = {:dial => number}
+
+      response = self.connection.get '/', params
+
+      response.env[:parsed_body]
+    rescue ProleneaError => pe
+      raise ProleneaLookupError.new({:parent_error => pe}), pe.message
+    rescue StandardError => se
+      raise ProleneaLookupError.new({:parent_error => se}), se.message
+    end
+
+  end
+
+  extend ClassMethods
+
+  Faraday::Response.register_middleware :prolenea_response => lambda { ProleneaResponseMiddleware }
+end

data/lib/prolenea/connection.rb

@@ -0,0 +1,74 @@
+module Prolenea
+  class Connection
+
+    USER_AGENT = "prolenea-client v#{Prolenea::VERSION}"
+
+    attr_accessor :options, :faraday
+
+    def initialize(options = {})
+      uri = options.delete :uri
+      @options = options
+      @faraday = self.create_faraday(uri, @options)
+    end
+
+    def create_faraday(uri, options = {})
+      @faraday = Faraday.new uri, options do |c|
+        c.headers['User-Agent'] = USER_AGENT
+
+        c.request :multipart
+        c.request :url_encoded
+
+        c.response :prolenea_response
+
+        c.adapter Faraday.default_adapter
+      end
+    end
+
+    def request(method, path, params, options, &callback)
+      sent_at = nil
+
+      response = @faraday.send(method) { |request|
+        sent_at = Time.now
+        request = config_request(request, method, path, params, options)
+      }.on_complete { |env|
+        env[:total_time] = Time.now.utc.to_f - sent_at.utc.to_f if sent_at
+        env[:request_params] = params
+        env[:request_options] = options
+        callback.call(env) if callback
+      }
+
+      response
+    rescue Faraday::Error => fe
+      raise ProleneaRequestError.new({:parent_error => fe}), fe.message
+    end
+
+    def config_request(request, method, path, params, options)
+      case method.to_sym
+      when :delete, :get
+        request.url(path, params)
+      when :post, :put
+        request.path = path
+        request.body = params unless params.empty?
+      end
+
+      request
+    end
+
+    def get(path, params={}, options={}, &callback)
+      request(:get, path, params, options, &callback)
+    end
+
+    def delete(path, params={}, options={}, &callback)
+      request(:delete, path, params, options, &callback)
+    end
+
+    def post(path, params={}, options={}, &callback)
+      request(:post, path, params, options, &callback)
+    end
+
+    def put(path, params={}, options={}, &callback)
+      request(:put, path, params, options, &callback)
+    end
+
+  end
+end

data/lib/prolenea/errors.rb

@@ -0,0 +1,18 @@
+module Prolenea
+  module Error
+    class ProleneaError < StandardError #:nodoc:
+      attr_accessor :options
+
+      def initialize(message, options = {})
+        @options = options
+        super message
+      end
+    end
+
+    class ProleneaRequestError < ProleneaError #:nodoc:
+    end
+
+    class ProleneaLookupError < ProleneaError #:nodoc:
+    end
+  end
+end

data/lib/prolenea/middleware/prolenea_response_middleware.rb

@@ -0,0 +1,45 @@
+module Prolenea
+  class ProleneaResponseMiddleware < Faraday::Response::Middleware
+
+    RESPONSE_ROW_NAMES = %w(
+      number
+      local_routing_number
+      ported_date
+      alternative_spid
+      alternative_spid_name
+      line_type
+      operating_company_number
+      operating_company_name
+      lata
+      city
+      state
+    )
+
+    def on_complete(env)
+      case env[:status]
+      when 200
+        env[:parsed_body] = self.parse_body env[:body]
+      else
+        raise ProleneaRequestError.new({}), "Recieved an unexpected HTTP response code #{env[:status]}"
+      end
+
+      env
+    end
+
+    def parse_body(body)
+      number_info = {}
+      rows = body.split("\r\n")
+
+      if rows.length != RESPONSE_ROW_NAMES.length
+        raise ProleneaRequestError.new({}), "Unable to parse HTTP response body"
+      end
+
+      rows.each_with_index do |row, i|
+        number_info[RESPONSE_ROW_NAMES[i]] = (row == '-' ? nil : row)
+      end
+
+      number_info
+    end
+
+  end
+end

data/lib/prolenea/version.rb

@@ -0,0 +1,3 @@
+module Prolenea
+  VERSION = '0.1.3'
+end

data/prolenea.gemspec

@@ -0,0 +1,30 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'prolenea/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'prolenea'
+  spec.version       = Prolenea::VERSION
+  spec.authors       = ['Keith Larrimore']
+  spec.email         = ['keithlarrimore@gmail.com']
+
+  spec.summary       = %q{IceHook System's Basic Ruby Client for Prolenea's LNP Query Service.}
+  spec.description   = %q{Executes queries to Prolenea's LNP API and parses the results and returns a cleaner JSON response.}
+  spec.homepage      = 'https://prolenea.com/'
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.bindir        = 'bin'
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  spec.add_development_dependency 'bundler', '~> 1.14'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rspec', '~> 3.0'
+  spec.add_development_dependency 'webmock', '~> 3.4.2'
+  spec.add_runtime_dependency 'faraday', '~> 0.15.2'
+  spec.add_runtime_dependency 'pry', '~> 0.11.3'
+end

metadata

@@ -0,0 +1,146 @@
+--- !ruby/object:Gem::Specification
+name: prolenea
+version: !ruby/object:Gem::Version
+  version: 0.1.3
+platform: ruby
+authors:
+- Keith Larrimore
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2018-06-28 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.14'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.14'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.4.2
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.4.2
+- !ruby/object:Gem::Dependency
+  name: faraday
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.15.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.15.2
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.11.3
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.11.3
+description: Executes queries to Prolenea's LNP API and parses the results and returns
+  a cleaner JSON response.
+email:
+- keithlarrimore@gmail.com
+executables:
+- prolenea-client
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README
+- README.md
+- Rakefile
+- bin/prolenea-client
+- lib/prolenea.rb
+- lib/prolenea/connection.rb
+- lib/prolenea/errors.rb
+- lib/prolenea/middleware/prolenea_response_middleware.rb
+- lib/prolenea/version.rb
+- prolenea.gemspec
+homepage: https://prolenea.com/
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.5.2
+signing_key: 
+specification_version: 4
+summary: IceHook System's Basic Ruby Client for Prolenea's LNP Query Service.
+test_files: []
+has_rdoc: