ine-places 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 9dad81de7fd70123ce91b50d22568e69f910a994
-  data.tar.gz: 290a56b5a99ca38e52b2fa4ebed1f04e89dce7da
+  metadata.gz: b1d5baf94a1ba569c3ac7935e3d5fd9faed8885f
+  data.tar.gz: 75728534fc49aa207cd83dcd7b96c567e3361764
 SHA512:
-  metadata.gz: 981b66c09a41e31bc87eb3079a7530d203a4f8c4b40fa9f961c8ad8753c77244eb6fdc43639968a2bfedce02944e6d85918ac89842177c2c5cdab7090c4ba9d4
-  data.tar.gz: 9cdaf505ba48b5b0d7bab4dc21fc0c7f3187f02e0b878e56fcf54dfff220273a238dd454eac49b83a8f71b9e4f3704d91518d6b966f4e9790d785bcf488ace5c
+  metadata.gz: 15bf45e03b9a9fa11b5addcc7f29d5e4ce833ead66e2c7764acd8ed80b1ec134a12bc282895fd199aee74eb54583c88dec03e7a606cf31da5101cddedcc2b651
+  data.tar.gz: 98e3a400affb297eadb45847dbe2ef548727fe25982f879f50b47d3ec16415b3927f5d54ee46db4f4bc08bf2b40af5a3fbeb2213603a585cd6986cc230142a15

data/README.md

@@ -1,22 +1,26 @@
 # INE Places gem
 
 [![Build Status](https://travis-ci.org/PopulateTools/ine-places.svg)](https://travis-ci.org/PopulateTools/ine-places)
+[![Gem Version](https://badge.fury.io/rb/ine-places.svg)](https://badge.fury.io/rb/ine-places)
 
 INE Places gem aims to help you to deal with Autonomous Regions, Provinces and Municipalities from
-Spain. This data is provided by the INE (Instituto Nacional Estadística) in this URL:
+Spain. This data is provided by the INE (Instituto Nacional Estadística) in these URLs (see the [Data License](https://github.com/PopulateTools/ine-places/#data_license) section for details about reuse rights):
 
-http://www.ine.es/daco/daco42/codmun/codmun11/11codmunmapa.htm
+- http://www.ine.es/daco/daco42/codmun/codmun11/11codmunmapa.htm
+- http://www.ine.es/jaxi/menu.do?type=pcaxis&path=/t20/e245/codmun&file=inebase&L=0
 
-According to that webpage the data **was updated on 01-01-2011**. As you might know municipalities
-data changes along the years: sometimes two municipalities are merged in a single one. For this
-reason it's important to know the date of the data.
+According to that webpage the data **was updated the 3rd of February, 2015**. As you might know municipalities
+data changes along the years: sometimes two municipalities are merged in a single one [more
+information in Spanish](http://www.ine.es/daco/daco42/codmun/codmunmod.htm). For this
+reason it's important to know the date of the data. The data included in this gem has been processed
+based on the data published on the INE (so, it was processed after the 3rd of Feb, 2015).
 
 ## Installation
 
 Add this line to your application's Gemfile:
 
 ```ruby
-gem 'ine-places'
+gem 'ine-places', require: 'ine/places/places'
 ```
 
 And then execute:
@@ -29,7 +33,7 @@ Or install it yourself as:
 
 ## Usage
 
-This gem provides three models:
+This gem provides three Ruby classes:
 
 - `INE::Places::AutonomousRegion`
 
@@ -48,7 +52,7 @@ The attributes of this model are:
 
 - id: INE code
 - name: the official name in the INE
-- slug: a sanitized name, valid for URLs
+- slug: a sanitized unique name, valid for URLs
 - lon: longitude of the central point
 - lat: latitude of the central point
 
@@ -87,7 +91,7 @@ The attributes of this model are:
 
 - id: INE code
 - name: the official name in the INE
-- slug: a sanitized name, valid for URLs
+- slug: a sanitized unique name, valid for URLs
 - autonomous_region_id: the INE code of the autonomous region
 - autonomous_region: the AutonomousRegion object
 - lon: longitude of the central point
@@ -128,7 +132,7 @@ The attributes of this model are:
 
 - id: INE code
 - name: the official name in the INE
-- slug: a sanitized name, valid for URLs
+- slug: a sanitized unique name, valid for URLs
 - province_id: the INE code of the province
 - province: the Province object
 - lon: longitude of the central point
@@ -169,7 +173,15 @@ To install this gem onto your local machine, run `bundle exec rake install`. To
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/PopulateTools/ine-places. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](contributor-covenant.org) code of conduct.
+Bug reports and pull requests are welcome on GitHub at https://github.com/PopulateTools/ine-places. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) [code of conduct](CODE_OF_CONDUCT.md).
+
+## Data License
+
+We have created the CSV files we use as source for the gem to make data availabale from data extracted from INE. In spanish and according to INE's own formula: 
+
+_Elaboración propia con datos extraídos del sitio web del INE: www.ine.es_
+
+Please read the conditions about reusing the data provided by this gem in INE's [Licensing page](http://www.ine.es/ss/Satellite?L=0&c=Page&cid=1254735849170&p=1254735849170&pagename=Ayuda%2FINELayout#) (in spanish).
 
 ## License
 

data/ine-places.gemspec

@@ -27,9 +27,9 @@ Gem::Specification.new do |spec|
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ["lib"]
 
-  spec.add_dependency "activesupport"
+  spec.add_runtime_dependency "activesupport", "~> 4.2", ">= 4.2.4"
 
   spec.add_development_dependency "bundler", "~> 1.10"
   spec.add_development_dependency "rake", "~> 10.0"
-  spec.add_development_dependency "rspec"
+  spec.add_development_dependency "rspec", "~> 3.3"
 end

data/lib/ine/places/csv_record.rb

@@ -12,15 +12,21 @@ module INE::Places::CSVRecord
     end
 
     def find_by_name(name)
-      collection_klass.records.detect{|obj| obj.name == name } if name.present?
+      raise ArgumentError if name.blank?
+
+      collection_klass.records.detect{|obj| obj.name == name }
     end
 
     def find_by_slug(slug)
-      collection_klass.records.detect{|obj| obj.slug == slug } if slug.present?
+      raise ArgumentError if slug.blank?
+
+      collection_klass.records.detect{|obj| obj.slug == slug }
     end
 
     def find(id)
-      collection_klass.records.detect{|obj| obj.id == id } if id.present?
+      raise ArgumentError if id.blank?
+
+      collection_klass.records.detect{|obj| obj.id == id }
     end
   end
 end

data/lib/ine/places/place.rb

@@ -2,7 +2,7 @@ class INE::Places::Place < OpenStruct
   include INE::Places::CSVRecord
 
   def self.find_all_by_province_id(province_id)
-    return [] if province_id.blank?
+    raise ArgumentError if province_id.blank?
 
     collection_klass.records.select{ |place| place.province_id == province_id }
   end

data/lib/ine/places/province.rb

@@ -2,9 +2,9 @@ class INE::Places::Province < OpenStruct
   include INE::Places::CSVRecord
 
   def self.find_all_by_autonomous_region_id(autonomous_region_id)
-    return [] if autonomous_region_id.blank?
+    raise ArgumentError if autonomous_region_id.blank?
 
-    collection_klass.records.select{ |province| province.autonomous_region_id == autonomous_region_id }
+    collection_klass.records.select{|province| province.autonomous_region_id == autonomous_region_id }
   end
 
   def places

data/lib/ine/places/version.rb

@@ -1,5 +1,5 @@
 module INE
   module Places
-    VERSION = "0.1.0"
+    VERSION = "0.1.1"
   end
 end

metadata

@@ -1,29 +1,35 @@
 --- !ruby/object:Gem::Specification
 name: ine-places
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - Fernando Blat
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2015-10-27 00:00:00.000000000 Z
+date: 2015-10-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
   requirement: !ruby/object:Gem::Requirement
     requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.2'
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 4.2.4
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.2'
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 4.2.4
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -56,16 +62,16 @@ dependencies:
   name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '3.3'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '3.3'
 description: Work with Spanish regions using INE codes and data
 email:
 - ferblape@gmail.com