opencellid-client 0.1.0 → 0.1.1

data/.gitignore

@@ -0,0 +1,5 @@
+Gemfile.lock
+coverage/
+pkg/
+.yardoc/
+doc/

data/.yardopts

@@ -0,0 +1 @@
+--no-private - License.txt

data/README.md

@@ -17,7 +17,7 @@ Usage
 
 First of all `require 'opencellid'` in your application.
 
-Read functionality (i.e. methods that only query the database generally do not require an API key), write methods instead
+Read functionality (i.e. methods that only query the database) generally do not require an API key, write methods instead
 do require an API key, so if you do not have one, head to the [OpenCellID website](http://www.opencellid.org/) and get one
 for yourself.
 
@@ -35,7 +35,7 @@ got from the response, otherwise an error object can be extracted from the respo
 methods to obtain the error code and human readable description.
 
 Querying Cells
-==============
+--------------
 
 Cells can be queried using a combination of parameters: the cell id, the mnc (operator) and mcc (country) code or the local area
 code lac. For a more detailed description of these parameters please refere to the OpenCellID site.
@@ -65,7 +65,7 @@ response = opencellid.get_cells_in_area(bbox, :limit => 10, :mnc => 5)
 cells = response.cells`
 
 Adding and Deleting Measures
-============================
+----------------------------
 
 Adding, deleting and listing "own" measures (i.e. measures inserted by the same user) require that an API key is
 made available to the library at initialization time.
@@ -91,6 +91,6 @@ measures = response.measures`
 
 
 Bulk addition of measures
-=========================
+-------------------------
 
 Bulk addition of measure by uploading a CSV formatted file to the OpenCellID server is not yet supported by this library.

data/lib/opencellid/bbox.rb

@@ -30,5 +30,4 @@ module Opencellid
   end
 
 
-
 end

data/lib/opencellid/cell.rb

@@ -22,7 +22,7 @@ module Opencellid
       @measures = []
     end
 
-
+    # Parses the given element setting the information into a Cell object
     # @param element [REXML::Element] the XML element containing the representation of the Cell element
     # @return [Cell] the Cell object obtained by parsing the XML
     def self.from_element(element)
@@ -41,22 +41,34 @@ module Opencellid
       result
     end
 
+
+    # Indicates whether this cell contains measure objects
     # @return [bool] whether this cell contains measure objects
     def has_measures?
       @measures.count > 0
     end
 
+    # Adds a new measure to this cell
     # @param measure [Measure] a measure object to be added to this cell. Note that adding the object to the cell
     # does NOT result in an add_measure call being invoked on the Opencellid object
     def add_measure(measure)
       @measures << measure
     end
 
-    # @return [Hash] a hash object containing the non nil paramters which can be used in while querying for cells
+    # Helper function that transforms the parameters of this cell in a hash of query parameters to be used
+    # 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?}
     end
 
+    # Returns an array containing the longitude and latitude of the cell, this method makes the Cell
+    # object to be compatible with mongoid_spacial gem
+    # @return [Array] an array containing longitude and latitude of the cell.
+    def to_lng_lat
+      [lon, lat]
+    end
+
   end
 
 end

data/lib/opencellid/error.rb

@@ -15,6 +15,7 @@ module Opencellid
       @code = code
     end
 
+    # Parses the given XML element extracting the information into the corresponding Error object
     # @param element [REXML::Element] an XML element containing the error
     # @return [Error] the error object created by parsing the XML element
     def self.from_element(element)

data/lib/opencellid/measure.rb

@@ -6,6 +6,7 @@ module Opencellid
   class Measure
 
     # The format used by the OpenCellId API to pass date/time information
+    # @private
     DATE_FORMAT = "%a %b %d %H:%M:%S %z %Y"
 
     attr_accessor :lat, :lon, :taken_by, :taken_on, :id, :signal
@@ -20,6 +21,7 @@ module Opencellid
     end
 
 
+    # Parses the given XML element extracting the information into the corresponding Measure object
     # @param element [REXML::Element] the XML element containing the representation of the measurement
     # @return [Measure] the Measure object obtained by parsing the XML
     def self.from_element(element)

data/lib/opencellid/opencellid.rb

@@ -6,14 +6,21 @@ require_relative 'measure'
 require_relative 'bbox'
 require_relative 'error'
 
+# The module for the opencellid-client gem
 module Opencellid
 
   # The main entry for this library. Each method maps to the corresponding method of the
   # OpenCellId API defined at {http:://www.opencellid.org/api}.
   class Opencellid
 
+    private
+    #the default URI used in all requests
     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]
+
+    public
     attr_reader :key
 
     # @param key [String] the API key used for "write" operations. Defaults to nil

data/lib/opencellid/response.rb

@@ -17,16 +17,19 @@ module Opencellid
       @ok = ok
     end
 
+    # Tells whether the response is a successful response or not
     # @return [bool] `true` if the response is a successful response
     def ok?
       @ok
     end
 
+    # Tells whether the response is a failure response or not
     # @return [bool] `true` if the response is a failure response
     def failed?
       not @ok
     end
 
+    # Parses the string containing the response as XML and returns the corresponding Response object
     # @param string [String] a string containing the XML response received from the server
     # @return [Response] the Response object obtained by parsing the XML file
     def self.from_xml(string)

data/lib/opencellid/version.rb

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

data/spec/lib/cell_spec.rb

@@ -131,7 +131,19 @@ XML
 
     end
 
+    describe "to_lng_lat" do
 
+      before do
+        @cell = Cell.new(1,2,3,4)
+        @cell.lat = 60.3276113
+        @cell.lon = 24.8689952
+      end
+
+      it "should return the correct array" do
+        @cell.to_lng_lat.should == [24.8689952,60.3276113]
+      end
+
+    end
 
   end
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: opencellid-client
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-02-06 00:00:00.000000000 Z
+date: 2012-02-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &70230512618500 !ruby/object:Gem::Requirement
+  requirement: &70362406860500 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,10 +21,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70230512618500
+  version_requirements: *70362406860500
 - !ruby/object:Gem::Dependency
   name: webmock
-  requirement: &70230512617380 !ruby/object:Gem::Requirement
+  requirement: &70362406859960 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -32,10 +32,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70230512617380
+  version_requirements: *70362406859960
 - !ruby/object:Gem::Dependency
   name: simplecov
-  requirement: &70230512616100 !ruby/object:Gem::Requirement
+  requirement: &70362406859380 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -43,7 +43,7 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70230512616100
+  version_requirements: *70362406859380
 description: A Ruby client for OpenCellID API
 email:
 - nessche@gmail.com
@@ -51,8 +51,9 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- .gitgnore
+- .gitignore
 - .simplecov
+- .yardopts
 - Gemfile
 - License.txt
 - README.md
@@ -120,3 +121,4 @@ test_files:
 - spec/lib/utils_spec.rb
 - spec/spec_helper.rb
 - spec/support/spec_utils.rb
+has_rdoc: 

data/.gitgnore

@@ -1,3 +0,0 @@
-Gemfile.lock
-coverage
-pkg