comcetera 0.2.0 → 0.3.1

data/README.rdoc

@@ -1,8 +1,10 @@
 = comcetera
 
-First stab at a simple class that wraps the Comcetera mobile operator detection service. Give them a msisdn, they give you an operator code. Compile your own list of relevant codes based on wikipedia.
+A simple wrapper for the NumberPortabilityLookup service of Comcetera. Give them a msisdn and they (usually) give you an operator code. Compile your own list of relevant codes based on wikipedia.
 
-I'm scratching my own itch here, so I'm only adding what I use. Feedback and patches are welcome
+I'm scratching my own itch here, so I'm only adding what I use. Feedback and patches are welcome.
+
+For more info about the service, take a look at: http://numberportabilitylookup.com/
 
 == Example
 
@@ -11,17 +13,21 @@ The usual way you'd do a lookup
   Comcetera.username = "meeeeee"
   Comcetera.password = "verysecret"
   comcetera = Comcetera.detect(31612345678)
-  comcetera.operator_code # => "T-Mobile"
+  comcetera.operator_code # => "20415"
   comcetera.msisdn        # => "31612345678"
 
 When the lookup does not work due to a timeout
+
   Comcetera.detect(31612345678) # => nil
 
-When the lookup gives a result, but not what you'd expect
+This means that the amount of retries specified as Comcetera.retries have all timed out after Comcetera.timeout seconds. You can retry at a later time or do something else. This is great if, as is my use case, the lookup is used as a type of pre-selection for numbers.
+
+The API can return a couple of errors. In this case, there is no operator code, but an error code and the full response as debug info.
 
   comcetera = Comcetera.detect(31612345678)
-  comcetera.error_code # => "ERR21"
-  comcetera.debug # => "QUERYOK\n31612345678 ERR21\nENDBATCH"
+  comcetera.operator_code # => nil
+  comcetera.error_code    # => "ERR21"
+  comcetera.debug         # => "QUERYOK\n31612345678 ERR21\nENDBATCH"
 
 == Operator codes
 
@@ -39,6 +45,11 @@ Example: Wikipedia mentions T-Mobile in the Netherlands as: MCC 204, MNC 16. Com
   (if you want to have your own version, that is fine but bump version in a commit by itself I can ignore when I pull)
 * Send me a pull request. Bonus points for topic branches.
 
+== Contributors
+
+* Wes 'Narnach' Oldenbeuving
+* Gerard 'smeevil' de Brieder
+
 == Copyright
 
 Copyright (c) 2010 Wes Oldenbeuving. See LICENSE for details.

data/VERSION

@@ -1 +1 @@
-0.2.0
+0.3.1

data/lib/comcetera.rb

@@ -2,8 +2,17 @@ require 'open-uri'
 require 'timeout'
 
 class Comcetera
+  ERROR_CODES={
+    "1"=>"Unknown subscriber",
+    "29"=>"Absent subscriber",
+    "21"=>"Facility not supported",
+    "11"=>"Teleserice not provisioned",
+    "13"=>"Call barred",
+    "36"=>"System Failure"
+  }
+
   attr_accessor :operator_code, :msisdn
-  attr_accessor :error_code, :debug
+  attr_accessor :error_code, :error_message, :debug
 
   def initialize(attributes={})
     attributes.each do |key, value|
@@ -21,7 +30,7 @@ class Comcetera
     def retries
       @retries ||= 2
     end
-    
+
     def password
       @password || raise("No password set for Comcetera")
     end
@@ -39,10 +48,10 @@ class Comcetera
           Timeout::timeout(self.timeout) do
             body=open("http://api.comcetera.com/npl?user=#{self.username}&pass=#{self.password}&msisdn=#{msisdn}").read
             msisdn, operator_code = body.split("\n")[1].split(" ") # 2nd line, last word is the operator hexcode
-            unless operator_code.to_s =~ /ERR\d+/
+            unless operator_code.to_s =~ /ERR(\d+)/
               return new(:operator_code => operator_code, :msisdn => msisdn)
             else
-              return new(:operator_code => nil, :msisdn => msisdn, :error_code=>operator_code, :debug=>body)
+              return new(:operator_code => nil, :msisdn => msisdn, :error_code=>operator_code, :error_message=>ERROR_CODES[$1]||"Unknown Error", :debug=>body)
             end
           end
         rescue Timeout::Error, SystemCallError => e

data/spec/comcetera_spec.rb

@@ -47,6 +47,7 @@ describe "Comcetera" do
       @comcetera = Comcetera.detect(31612345621)
       @comcetera.operator_code.should be_nil
       @comcetera.error_code.should == "ERR21"
+      @comcetera.error_message.should == "Facility not supported"
       @comcetera.debug.should == <<-MSG
 QUERYOK
 31612345621 ERR21

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: comcetera
 version: !ruby/object:Gem::Version 
-  hash: 23
+  hash: 17
   prerelease: false
   segments: 
   - 0
-  - 2
-  - 0
-  version: 0.2.0
+  - 3
+  - 1
+  version: 0.3.1
 platform: ruby
 authors: 
 - Wes Oldenbeuving
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-08-09 00:00:00 +02:00
+date: 2010-09-29 00:00:00 +02:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency