comcetera 0.2.0

data/.document

@@ -0,0 +1,5 @@
+README.rdoc
+lib/**/*.rb
+bin/*
+features/**/*.feature
+LICENSE

data/.gitignore

@@ -0,0 +1,22 @@
+## MAC OS
+.DS_Store
+
+## TEXTMATE
+*.tmproj
+tmtags
+
+## EMACS
+*~
+\#*
+.\#*
+
+## VIM
+*.swp
+
+## PROJECT::GENERAL
+coverage
+rdoc
+pkg
+
+## PROJECT::SPECIFIC
+*.gemspec

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 Wes Oldenbeuving
+
+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.rdoc

@@ -0,0 +1,44 @@
+= 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.
+
+I'm scratching my own itch here, so I'm only adding what I use. Feedback and patches are welcome
+
+== Example
+
+The usual way you'd do a lookup
+
+  Comcetera.username = "meeeeee"
+  Comcetera.password = "verysecret"
+  comcetera = Comcetera.detect(31612345678)
+  comcetera.operator_code # => "T-Mobile"
+  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
+
+  comcetera = Comcetera.detect(31612345678)
+  comcetera.error_code # => "ERR21"
+  comcetera.debug # => "QUERYOK\n31612345678 ERR21\nENDBATCH"
+
+== Operator codes
+
+Check the wikipedia page for Mobile Network Codes (http://en.wikipedia.org/wiki/Mobile_Network_Code) for a list of codes that you can expect.
+
+Example: Wikipedia mentions T-Mobile in the Netherlands as: MCC 204, MNC 16. Comcetera would return this as code 20416. This logic seems consistent across countries.
+
+== Note on Patches/Pull Requests
+
+* Fork the project.
+* Make your feature addition or bug fix.
+* Add tests for it. This is important so I don't break it in a
+  future version unintentionally.
+* Commit, do not mess with rakefile, version, or history.
+  (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.
+
+== Copyright
+
+Copyright (c) 2010 Wes Oldenbeuving. See LICENSE for details.

data/Rakefile

@@ -0,0 +1,46 @@
+require 'rubygems'
+require 'rake'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "comcetera"
+    gem.summary = "Wrapper class for Comcetera mobile operator detection based on msisdn."
+    gem.description = gem.summary
+    gem.email = "narnach@gmail.com"
+    gem.homepage = "http://github.com/Narnach/comcetera"
+    gem.authors = ["Wes Oldenbeuving"]
+    gem.add_development_dependency "rspec", ">= 1.2.9"
+    gem.add_development_dependency "fakeweb"
+    # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
+  end
+  Jeweler::GemcutterTasks.new
+rescue LoadError
+  puts "Jeweler (or a dependency) not available. Install it with: gem install jeweler"
+end
+
+require 'spec/rake/spectask'
+Spec::Rake::SpecTask.new(:spec) do |spec|
+  spec.libs << 'lib' << 'spec'
+  spec.spec_files = FileList['spec/**/*_spec.rb']
+end
+
+Spec::Rake::SpecTask.new(:rcov) do |spec|
+  spec.libs << 'lib' << 'spec'
+  spec.pattern = 'spec/**/*_spec.rb'
+  spec.rcov = true
+end
+
+task :spec => :check_dependencies
+
+task :default => :spec
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "comcetera #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+0.2.0

data/lib/comcetera.rb

@@ -0,0 +1,55 @@
+require 'open-uri'
+require 'timeout'
+
+class Comcetera
+  attr_accessor :operator_code, :msisdn
+  attr_accessor :error_code, :debug
+
+  def initialize(attributes={})
+    attributes.each do |key, value|
+      self.send("#{key}=", value)
+    end
+  end
+
+  class << self
+    attr_accessor :username, :password, :timeout, :retries
+
+    def timeout
+      @timeout ||= 2
+    end
+
+    def retries
+      @retries ||= 2
+    end
+    
+    def password
+      @password || raise("No password set for Comcetera")
+    end
+
+    def username
+      @username || raise("No username set for Comcetera")
+    end
+
+    # Attempt an operator lookup based on msisdn.
+    def detect(msisdn)
+      attempts = 0
+      while attempts <= self.retries
+        attempts += 1
+        begin
+          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+/
+              return new(:operator_code => operator_code, :msisdn => msisdn)
+            else
+              return new(:operator_code => nil, :msisdn => msisdn, :error_code=>operator_code, :debug=>body)
+            end
+          end
+        rescue Timeout::Error, SystemCallError => e
+          # ignore
+        end
+      end
+      nil
+    end
+  end
+end

data/spec/comcetera_spec.rb

@@ -0,0 +1,57 @@
+require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+
+FakeWeb.register_uri :get, 'http://api.comcetera.com/npl?user=username&pass=password&msisdn=31612345678', :body=> <<-MSG
+QUERYOK
+31612345678 12345
+ENDBATCH
+MSG
+FakeWeb.register_uri :get, 'http://api.comcetera.com/npl?user=username&pass=password&msisdn=31612345621', :body=> <<-MSG
+QUERYOK
+31612345621 ERR21
+ENDBATCH
+MSG
+
+describe "Comcetera" do
+  before(:all) do
+    Comcetera.username = "username"
+    Comcetera.password = "password"
+  end
+
+  describe "detect" do
+    it "should return a new Comcetera instance" do
+      @comcetera = Comcetera.detect(31612345678)
+      @comcetera.should be_instance_of(Comcetera)
+    end
+
+    it "should retry after a timeout and return nil when it still fails" do
+      3.times {Timeout.should_receive(:timeout).with(2).and_raise(Timeout::Error)}
+      @comcetera = Comcetera.detect(31612345678)
+      @comcetera.should be_nil
+    end
+
+    describe "the returned Comcetera instance" do
+      before(:each) do
+        @comcetera = Comcetera.detect(31612345678)
+      end
+
+      it "should contain the returned operator code" do
+        @comcetera.operator_code.should == "12345"
+      end
+
+      it "should contain the returned msisdn" do
+        @comcetera.msisdn.should == "31612345678"
+      end
+    end
+    
+    it "should return an instance with error code and debug info when no operator code is returned" do
+      @comcetera = Comcetera.detect(31612345621)
+      @comcetera.operator_code.should be_nil
+      @comcetera.error_code.should == "ERR21"
+      @comcetera.debug.should == <<-MSG
+QUERYOK
+31612345621 ERR21
+ENDBATCH
+      MSG
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,12 @@
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+require 'comcetera'
+require 'spec'
+require 'spec/autorun'
+require 'fakeweb'
+
+Spec::Runner.configure do |config|
+  config.before do
+    FakeWeb.allow_net_connect = false
+  end
+end

metadata

@@ -0,0 +1,106 @@
+--- !ruby/object:Gem::Specification 
+name: comcetera
+version: !ruby/object:Gem::Version 
+  hash: 23
+  prerelease: false
+  segments: 
+  - 0
+  - 2
+  - 0
+  version: 0.2.0
+platform: ruby
+authors: 
+- Wes Oldenbeuving
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-08-09 00:00:00 +02:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 13
+        segments: 
+        - 1
+        - 2
+        - 9
+        version: 1.2.9
+  type: :development
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: fakeweb
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id002
+description: Wrapper class for Comcetera mobile operator detection based on msisdn.
+email: narnach@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+- README.rdoc
+files: 
+- .document
+- .gitignore
+- LICENSE
+- README.rdoc
+- Rakefile
+- VERSION
+- lib/comcetera.rb
+- spec/comcetera_spec.rb
+- spec/spec_helper.rb
+has_rdoc: true
+homepage: http://github.com/Narnach/comcetera
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: Wrapper class for Comcetera mobile operator detection based on msisdn.
+test_files: 
+- spec/comcetera_spec.rb
+- spec/spec_helper.rb