open_market 1.0

data/MIT-LICENSE

@@ -0,0 +1,7 @@
+Copyright (c) 2010 Aleksey Gureiev and Recess Mobile, Inc.
+
+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,39 @@
+Open Market integration kit
+===========================
+
+Open Market integration kit is intended to help working with the Open Market API
+from your Ruby applications.
+
+To use the kit, you need to be a registered user of Open Market (http://openmarket.com)
+and have Account ID and Account Password.
+
+
+Installation
+============
+
+  gem install open_market
+
+
+Usage
+=====
+
+  om = OpenMarket::Base.new('xxx-xxx-xxx-xxxxx', '<your_account_password>')
+
+  # Looking up details on the phone number
+  res = om.preview('+16123327465')
+  if res.success?
+    res.destination         # hash of destination details
+    res.operator            # hash of operator details
+    res.location            # hash of geographical data
+  else
+    res.error[:code]        # error code
+    res.error[:description] # details error description
+    res.error[:resolution]  #
+  end
+
+
+License
+=======
+
+Circuit Breaker is Copyright © 2010 [Aleksey Gureiev](mailto:spyromus@noizeramp.com) and [Recess Mobile](http://recessmobile.com/).
+It is free software, and may be redistributed under the terms specified in the MIT-LICENSE file.

data/lib/open_market/base.rb

@@ -0,0 +1,42 @@
+module OpenMarket
+  class Base
+    
+    def initialize(account_id, account_password, options = {})
+      @account_id = account_id
+      @account_password = account_password
+
+      @server = options[:server] || 'smsc-01.openmarket.com'
+      @path   = options[:path] || '/wmp'
+    end
+    
+    def preview(phone_number)
+      request(:type => 'preview', :destination => { :address => phone_number })
+    end
+    
+    private
+    
+    def xml_packet(options = {})
+      d = REXML::Document.new
+      d << REXML::XMLDecl.new
+
+      request = d.add_element 'request', 'version' => "3.0", 'protocol' => "wmp", 'type' => options[:type]
+      request.add_element 'account', 'id' => @account_id, 'password' => @account_password
+      
+      if (dest = options[:destination])
+        request.add_element 'destination', 'ton' => (dest[:ton] || 0), 'address' => dest[:address]
+      end
+
+      d.to_s
+    end
+    
+    def request(options = {})
+      response = nil
+
+      Net::HTTP.start(@server) do |q|
+        response = q.post(@path, xml_packet(options), { 'Content-Type' => 'text/xml' }).body
+      end
+
+      Response.new(response)
+    end
+  end
+end

data/lib/open_market/response.rb

@@ -0,0 +1,91 @@
+module OpenMarket
+  class Response
+    
+    attr_reader :error, :destination, :location, :operator
+
+    def initialize(xml)
+      @doc = REXML::Document.new(xml)
+      puts xml
+      
+      get_error
+      get_destination
+      get_location
+      get_operator
+    end
+
+    def success?
+      @error && @error[:code] == 0
+    end
+    
+    private
+    
+    def get_error
+      el = @doc.root.elements['error']
+      @error = {
+        :code         => el.attributes['code'].to_i,
+        :description  => el.attributes['description'],
+        :resolution   => el.attributes['resolution'] }
+    end
+    
+    def get_destination
+      el = @doc.root.elements['destination']
+      return if el.nil?
+      
+      @destination = {
+        :country_code         => el.attributes['country_code'].to_i,
+        :national_number      => el.attributes['national_number'],
+        :intl_notation        => el.attributes['intl_notation'],
+        :area_code            => el.attributes['area_code'],
+        :area_code_length     => el.attributes['area_code_length'].to_i,
+        :num_min_length       => el.attributes['num_min_length'].to_i,
+        :num_max_length       => el.attributes['num_max_length'].to_i,
+        :na_nxx               => el.attributes['na_nxx'],
+        :na_line              => el.attributes['na_line'],
+        :local_notation       => el.attributes['local_notation'],
+        :local_format         => el.attributes['local_format'],
+        :digits_all           => el.attributes['digits_all'].to_i,
+        :digits_local         => el.attributes['digits_local'].to_i,
+        :ported               => el.attributes['ported'] == 'true',
+        :ported_from          => el.attributes['ported_from'].to_i }
+    end
+    
+    def get_location
+      el = @doc.root.elements['location']
+      return if el.nil?
+
+      @location = {
+        :zone                 => el.attributes['zone'].to_i,
+        :zone_name            => el.attributes['zone_name'],
+        :country              => el.attributes['country'],
+        :country_name         => el.attributes['country_name'],
+        :region               => el.attributes['region'],
+        :region_name          => el.attributes['region_name'],
+        :city                 => el.attributes['city'],
+        :timezone_min         => el.attributes['timezone_min'],
+        :timezone_max         => el.attributes['timezone_max'],
+        :estimated_latitude   => el.attributes['estimated_latitude'],
+        :estimated_longitude  => el.attributes['estimated_longitude'] }
+    end
+    
+    def get_operator
+      el = @doc.root.elements['operator']
+      return if el.nil?
+
+      @operator = {
+        :id                   => el.attributes['id'].to_i,
+        :name                 => el.attributes['name'],
+        :text_length          => el.attributes['text_length'].to_i,
+        :binary_length        => el.attributes['binary_length'].to_i,
+        :unicode_length       => el.attributes['unicode_length'].to_i,
+        :binary               => el.attributes['binary'] == 'true',
+        :unicode              => el.attributes['unicode'] == 'true',
+        :smart_messaging      => el.attributes['smart_messaging'] == 'true',
+        :wap_push             => el.attributes['wap_push'] == 'true',
+        :ems                  => el.attributes['ems'] == 'ems',
+        :price                => el.attributes['price'].to_f,
+        :price_currency       => el.attributes['price_currency'],
+        :price_plan           => el.attributes['price_plan'],
+        :price_tier           => el.attributes['price_tier'].to_i }
+    end
+  end
+end

data/lib/open_market.rb

@@ -0,0 +1,7 @@
+require 'rubygems'
+require 'rexml/document'
+require 'net/http'
+
+dirname = File.dirname(__FILE__)
+require dirname + '/open_market/response'
+require dirname + '/open_market/base'

data/spec/spec_helper.rb

@@ -0,0 +1,4 @@
+require 'rubygems'
+require 'spec'
+
+require File.dirname(__FILE__) + "/../lib/open_market"

data/spec/unit/open_market/response_spec.rb

@@ -0,0 +1,75 @@
+require File.dirname(__FILE__) + '/../../spec_helper'
+
+describe OpenMarket::Response do
+  
+  describe "when receiving preview responses" do
+    it "should parse successful" do
+      xml = '<?xml version="1.0"?><response version="3.0" protocol="wmp" type="preview"><error code="0" description="No Error" resolution=""/><destination country_code="1" national_number="6147389968" intl_notation="+16147389968" area_code="614" area_code_length="3" num_min_length="7" num_max_length="7" na_nxx="738" na_line="9968" local_notation="(614) 738-9968" local_format="(###) ###-####" digits_all="11" digits_local="10" ported="false" ported_from="0"/><location zone="1" zone_name="North America, Caribbean" country="US" country_name="United States" region="OH" region_name="Ohio" city="Columbus" timezone_min="-5" timezone_max="-5" estimated_latitude="39.96" estimated_longitude="-83.00"/><operator  id="77" name="Verizon" text_length="160" binary_length="0" unicode_length="0" binary="false" unicode="false" smart_messaging="false" wap_push="false" ems="false" price="0.0320" price_currency="USD" price_plan="Dedicated" price_tier="1"/></response>'
+      r = OpenMarket::Response.new(xml)
+      r.should be_success
+
+      r.error[:code].should           == 0
+      r.error[:description].should    == "No Error"
+      r.error[:resolution].should     == ""
+      
+      d = r.destination
+      d[:country_code].should         == 1
+      d[:national_number].should      == "6147389968"
+      d[:intl_notation].should        == "+16147389968"
+      d[:area_code].should            == "614"
+      d[:area_code_length].should     == 3
+      d[:num_min_length].should       == 7
+      d[:num_max_length].should       == 7
+      d[:na_nxx].should               == "738"
+      d[:na_line].should              == "9968"
+      d[:local_notation].should       == "(614) 738-9968"
+      d[:local_format].should         == "(###) ###-####"
+      d[:digits_all].should           == 11
+      d[:digits_local].should         == 10
+      d[:ported].should               == false
+      d[:ported_from].should          == 0
+      
+      l = r.location
+      l[:zone].should                 == 1
+      l[:zone_name].should            == "North America, Caribbean"
+      l[:country].should              == "US"
+      l[:country_name].should         == "United States"
+      l[:region].should               == "OH"
+      l[:region_name].should          == "Ohio"
+      l[:city].should                 == "Columbus"
+      l[:timezone_min].should         == "-5"
+      l[:timezone_max].should         == "-5"
+      l[:estimated_latitude].should   == "39.96"
+      l[:estimated_longitude].should  == "-83.00"
+      
+      o = r.operator
+      o[:id].should                   == 77
+      o[:name].should                 == "Verizon"
+      o[:text_length].should          == 160
+      o[:binary_length].should        == 0
+      o[:unicode_length].should       == 0
+      o[:binary].should               == false
+      o[:unicode].should              == false
+      o[:smart_messaging].should      == false
+      o[:wap_push].should             == false
+      o[:ems].should                  == false
+      o[:price].should                == 0.032
+      o[:price_currency].should       == "USD"
+      o[:price_plan].should           == "Dedicated"
+      o[:price_tier].should           == 1
+    end
+    
+    it "should parse error" do
+      xml = '<?xml version="1.0"?><response version="3.0" protocol="wmp" type="preview"><error code="345" description="Unable to determine carrier id from pin or destination address." resolution=""/></response>'
+      r = OpenMarket::Response.new(xml)
+      
+      r.should_not be_success
+      
+      r.error[:code].should           == 345
+      r.error[:description].should    == "Unable to determine carrier id from pin or destination address."
+      r.error[:resolution].should     == ""
+    end
+    
+  end
+  
+end

metadata

@@ -0,0 +1,68 @@
+--- !ruby/object:Gem::Specification 
+name: open_market
+version: !ruby/object:Gem::Version 
+  prerelease: false
+  segments: 
+  - 1
+  - 0
+  version: "1.0"
+platform: ruby
+authors: 
+- Aleksey Gureiev
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-08-17 00:00:00 +03:00
+default_executable: 
+dependencies: []
+
+description: Open Market integration kit
+email: spyromus@noizeramp.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- README.md
+files: 
+- README.md
+- MIT-LICENSE
+- lib/open_market/base.rb
+- lib/open_market/response.rb
+- lib/open_market.rb
+- spec/spec_helper.rb
+- spec/unit/open_market/response_spec.rb
+has_rdoc: true
+homepage: ""
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --line-numbers
+- --inline-source
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: open_market
+rubygems_version: 1.3.6
+signing_key: 
+specification_version: 3
+summary: Open Market integration kit
+test_files: 
+- spec/unit/open_market/response_spec.rb