opencellid-client 0.1.1 → 0.1.2

data/.travis.yml

@@ -0,0 +1,5 @@
+language: ruby
+rvm:
+  - "1.9.3"
+
+script: bundle exec rake spec yard

data/Gemfile

@@ -1,4 +1,4 @@
 source "http://rubygems.org"
 
-# Specify your gem's dependencies in aebus.gemspec
+# Specify your gem's dependencies in opencellid-client.gemspec
 gemspec

data/README.md

@@ -1,6 +1,10 @@
 OpenCellID Client Library
 =========================
 
+
+[![Build Status](https://travis-ci.org/nessche/opencellid-client.png)](https://travis-ci.org/nessche/opencellid-client)
+
+
 `opencellid-client` is a ruby gem that aims at simplifying the usage of the APIs provided by opencellid.org to transform cell IDs into coordinates.
 
 Installing

data/Rakefile

@@ -1,4 +1,10 @@
 require 'bundler/gem_tasks'
 require 'rspec/core/rake_task'
+require 'yard'
+require 'yard/rake/yardoc_task'
 
-RSpec::Core::RakeTask.new('spec')
+RSpec::Core::RakeTask.new('spec')
+
+YARD::Rake::YardocTask.new('yard')
+
+task :default => :spec

data/lib/opencellid/bbox.rb

@@ -11,10 +11,10 @@ module Opencellid
     # @param latmax [Float] latmax the latitude of the NE corner of the box
     # @param lonmax [Float] lonmax the longitude of the NE corner of the box
     def initialize(latmin, lonmin, latmax, lonmax)
-      raise ArgumentError, "latmin must not be nil" unless latmin
-      raise ArgumentError, "lonmin must not be nil" unless lonmin
-      raise ArgumentError, "latmax must not be nil" unless latmax
-      raise ArgumentError, "lonmax must not be nil" unless lonmax
+      raise ArgumentError, 'latmin must not be nil' unless latmin
+      raise ArgumentError, 'lonmin must not be nil' unless lonmin
+      raise ArgumentError, 'latmax must not be nil' unless latmax
+      raise ArgumentError, 'lonmax must not be nil' unless lonmax
       @latmin = latmin
       @lonmin = lonmin
       @latmax = latmax

data/lib/opencellid/cell.rb

@@ -27,8 +27,8 @@ module Opencellid
     # @return [Cell] the Cell object obtained by parsing the XML
     def self.from_element(element)
       return nil unless element
-      raise ArgumentError, "element must be of type XEXML::Element" unless element.is_a? REXML::Element
-      raise ArgumentError, "element must be a <cell>" unless element.name == "cell"
+      raise ArgumentError, 'element must be of type XEXML::Element' unless element.is_a? REXML::Element
+      raise ArgumentError, 'element must be a <cell>' unless element.name == 'cell'
       attrs = element.attributes
 
       result = Cell.new(::Opencellid.to_i_or_nil(attrs['cellId']), ::Opencellid.to_i_or_nil(attrs['mnc']),
@@ -59,7 +59,7 @@ module Opencellid
     # with the library cell querying functions
     # @return [Hash] a hash object containing the non nil parameters which can be used in while querying for cells
     def to_query_hash
-      {cellid: id, mnc: mnc, mcc: mcc, lac: lac}.delete_if {|k,v| v.nil?}
+      {cellid: id, mnc: mnc, mcc: mcc, lac: lac}.delete_if {|_,v| v.nil?}
     end
 
     # Returns an array containing the longitude and latitude of the cell, this method makes the Cell

data/lib/opencellid/error.rb

@@ -20,8 +20,8 @@ module Opencellid
     # @return [Error] the error object created by parsing the XML element
     def self.from_element(element)
       return nil unless element
-      raise ArgumentError, "element must be of type XEXML::Element" unless element.is_a? REXML::Element
-      raise ArgumentError, "element must be an <err>" unless element.name == "err"
+      raise ArgumentError, 'element must be of type XEXML::Element' unless element.is_a? REXML::Element
+      raise ArgumentError, 'element must be an <err>' unless element.name == 'err'
       attrs = element.attributes
       return Error.new(::Opencellid.to_i_or_nil(attrs['code']),attrs['info'])
     end

data/lib/opencellid/measure.rb

@@ -7,7 +7,7 @@ module Opencellid
 
     # The format used by the OpenCellId API to pass date/time information
     # @private
-    DATE_FORMAT = "%a %b %d %H:%M:%S %z %Y"
+    DATE_FORMAT = '%a %b %d %H:%M:%S %z %Y'
 
     attr_accessor :lat, :lon, :taken_by, :taken_on, :id, :signal
 
@@ -26,8 +26,8 @@ module Opencellid
     # @return [Measure] the Measure object obtained by parsing the XML
     def self.from_element(element)
       return nil unless element
-      raise ArgumentError, "element must be of type XEXML::Element" unless element.is_a? REXML::Element
-      raise ArgumentError, "element must be a <measure>" unless element.name == "measure"
+      raise ArgumentError, 'element must be of type XEXML::Element' unless element.is_a? REXML::Element
+      raise ArgumentError, 'element must be a <measure>' unless element.name == 'measure'
       attrs = element.attributes
       date = attrs['takenOn']
       date ||= attrs['measured_at']

data/lib/opencellid/opencellid.rb

@@ -15,7 +15,7 @@ module Opencellid
 
     private
     #the default URI used in all requests
-    DEFAULT_URI = "http://www.opencellid.org"
+    DEFAULT_URI = 'http://www.opencellid.org'
 
     # the list of parameters allowed in the options for get_cells_in_area
     GET_IN_AREA_ALLOWED_PARAMS = [:limit, :mcc, :mnc]
@@ -32,7 +32,7 @@ module Opencellid
     # @param[Cell] cell the object containing the parameters to be used in searching the database
     # the result received from the server
     def get_cell(cell)
-      query_cell_info "/cell/get", cell
+      query_cell_info '/cell/get', cell
     end
 
     # Retrieves the cell information and the measures used to calculate its position based on the parameters
@@ -40,7 +40,7 @@ module Opencellid
     # @param[Cell] cell the object containing the parameters used to search the cell database
     # @return[Response] the result received from the server
     def get_cell_measures(cell)
-      query_cell_info "/cell/getMeasures", cell
+      query_cell_info '/cell/getMeasures', cell
     end
 
     # Retrieves all the cells located inside the bounding box and whose parameters match the ones specified in the options
@@ -49,11 +49,11 @@ module Opencellid
     # of results), `:mnc` specifying the mnc value of the desired cells and `:mcc` specifying the mcc value of the desired cells
     # @return [Response] the result received from the server
     def get_cells_in_area(bbox, options = {})
-      raise ArgumentError, "options must be a Hash" unless options.is_a? Hash
-      raise ArgumentError, "bbox must be of type BBox" unless bbox.is_a? BBox
+      raise ArgumentError, 'options must be a Hash' unless options.is_a? Hash
+      raise ArgumentError, 'bbox must be of type BBox' unless bbox.is_a? BBox
       params = {bbox: bbox.to_s, fmt: 'xml'}
       params.merge!(options.reject { |key| !GET_IN_AREA_ALLOWED_PARAMS.include? key})
-      execute_request_and_parse_response "/cell/getInArea", params
+      exec_req_and_parse_response '/cell/getInArea', params
     end
 
     # Adds a measure (specified by the measure object) to a given cell (specified by the cell object). In case of
@@ -71,13 +71,13 @@ module Opencellid
       params[:lon] = measure.lon
       params[:signal] = measure.signal if measure.signal
       params[:measured_at] = measure.taken_on if measure.taken_on
-      execute_request_and_parse_response "/measure/add", params
+      exec_req_and_parse_response "/measure/add", params
     end
 
     # List the measures added with a given API key.
     # @return [Response] the result received from the server
     def list_measures
-      execute_request_and_parse_response "/measure/list"
+      exec_req_and_parse_response "/measure/list"
     end
 
     # Deletes a measure previously added with the same API key.
@@ -85,7 +85,7 @@ module Opencellid
     # @return [Response] the result received from the server
     def delete_measure(measure_id)
       raise ArgumentError,"measure_id cannot be nil" unless measure_id
-      execute_request_and_parse_response "/measure/delete", {id: measure_id}
+      exec_req_and_parse_response "/measure/delete", {id: measure_id}
     end
 
   protected
@@ -93,10 +93,10 @@ module Opencellid
     def query_cell_info(path, cell)
       raise ArgumentError, "cell must be a Cell" unless cell.is_a? Cell
       params = cell.to_query_hash
-      execute_request_and_parse_response path, params
+      exec_req_and_parse_response path, params
     end
 
-    def execute_request_and_parse_response(path, params = {})
+    def exec_req_and_parse_response(path, params = {})
       params[:key] = @key if @key
       uri = URI(DEFAULT_URI + path)
       uri.query = URI.encode_www_form params if params.count > 0

data/lib/opencellid/version.rb

@@ -1,5 +1,5 @@
 module Opencellid
 
   # This library current version
-  VERSION = "0.1.1"
+  VERSION = '0.1.2'
 end

data/opencellid-client.gemspec

@@ -23,5 +23,8 @@ Gem::Specification.new do |s|
   s.add_development_dependency "rspec"
   s.add_development_dependency "webmock"
   s.add_development_dependency "simplecov"
+  s.add_development_dependency "rake"
+  s.add_development_dependency "yard"
+  s.add_development_dependency "redcarpet"
   # s.add_runtime_dependency "rest-client"
 end

data/spec/lib/opencellid_spec.rb

@@ -13,46 +13,46 @@ module Opencellid
       Response.stub(:from_xml).and_return(@response)
     end
 
-    describe "execute_request_and_parse_response" do
+    describe 'exec_req_and_parse_response' do
 
       before do
-        @method = @oci.method(:execute_request_and_parse_response)
+        @method = @oci.method(:exec_req_and_parse_response)
 
       end
 
-      context "when the api key is specified" do
+      context 'when the api key is specified' do
 
         before do
-          @oci = Opencellid.new "myapikey"
-          @method = @oci.method(:execute_request_and_parse_response)
+          @oci = Opencellid.new 'myapikey'
+          @method = @oci.method(:exec_req_and_parse_response)
         end
 
-        it "should add it to the parameters" do
+        it 'should add it to the parameters' do
           @method.call("/")
-          WebMock.should have_requested(:get, "www.opencellid.org/")
-                         .with(query: { "key" => "myapikey"})
+          WebMock.should have_requested(:get, 'www.opencellid.org/')
+                         .with(query: { 'key' => 'myapikey'})
         end
 
       end
 
-      context "when the api key is not specified" do
+      context 'when the api key is not specified' do
 
-        it "should not add it to the parameters" do
-          @method.call("/")
-          WebMock.should have_requested(:get, "www.opencellid.org/")
+        it 'should not add it to the parameters' do
+          @method.call('/')
+          WebMock.should have_requested(:get, 'www.opencellid.org/')
         end
 
       end
 
-      it "should add the params as query params" do
+      it 'should add the params as query params' do
 
-        @method.call("/",{"a" => "10", "b" => "20", "c" => "30"})
-        WebMock.should have_requested(:get, "www.opencellid.org/")
+        @method.call('/',{"a" => "10", "b" => "20", "c" => "30"})
+        WebMock.should have_requested(:get, 'www.opencellid.org/')
                        .with(query: {"a" => "10", "b" => "20", "c" => "30"})
       end
 
-      it "should set the path correctly" do
-        @method.call("/mypath")
+      it 'should set the path correctly' do
+        @method.call('/mypath')
         WebMock.should have_requested(:get, "www.opencellid.org/mypath")
       end
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: opencellid-client
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.2
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-02-10 00:00:00.000000000 Z
+date: 2013-02-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &70362406860500 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,10 +21,15 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70362406860500
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: webmock
-  requirement: &70362406859960 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -32,10 +37,47 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70362406859960
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: simplecov
-  requirement: &70362406859380 !ruby/object:Gem::Requirement
+  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'
+- !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'
+- !ruby/object:Gem::Dependency
+  name: yard
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -43,7 +85,28 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70362406859380
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: redcarpet
+  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: A Ruby client for OpenCellID API
 email:
 - nessche@gmail.com
@@ -53,6 +116,7 @@ extra_rdoc_files: []
 files:
 - .gitignore
 - .simplecov
+- .travis.yml
 - .yardopts
 - Gemfile
 - License.txt
@@ -94,15 +158,21 @@ required_ruby_version: !ruby/object:Gem::Requirement
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
+      segments:
+      - 0
+      hash: 868652574644727038
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
+      segments:
+      - 0
+      hash: 868652574644727038
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.10
+rubygems_version: 1.8.24
 signing_key: 
 specification_version: 3
 summary: A Ruby client for OpenCellID API