sepomex 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 7e1595f4b7e9caf263e845125b0147495becf068
-  data.tar.gz: 276d81b2f1f31300853eef370f3eaf0497045d7c
+  metadata.gz: 60a528b01402e995f58a69698b2a7bcf668186a7
+  data.tar.gz: fbfaf235a30f421fc0d61597ca253c18f9e2764b
 SHA512:
-  metadata.gz: 362b9b2733fa9dd0c991eb04ea4acca726bc143c17c4e75dd9a40589b1d5ee509397472ccb4319fb078a2f95ca9d8384297082fed6a5ec5c0c38ad5b9f686388
-  data.tar.gz: 37fad23a8f0c3dfff48646be9278ff5cc0beaff1f4df27d255ea6a048a96e158a0a32905d886ca83c30b216a81e74eed1635553c1f9a24b9cee69b74c7d31118
+  metadata.gz: 966dc72e1fbf1daad4fd2bd85eb2e6eb8449a63ed8c32e041511d3544598ca603731b6c6cf739798f8b5e37f0172dd1d074a32e196327fb24b679448c789cb02
+  data.tar.gz: a93a57c27ad52455a9e253c6584b7617409df823ebb3baa872b6e55016cd77488c01d6296fe43da9e9798cfcd168d87b97b971efff6f8417581388cdfb2a149a

data/.gitignore

@@ -8,3 +8,4 @@
 /spec/reports/
 /tmp/
 .DS_Store
+*.gem

data/README.md

@@ -1,10 +1,17 @@
-# Sepomex
+# Sepomex-rb
 
-Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/sepomex`. To experiment with that code, run `bin/console` for an interactive prompt.
+A super simple Ruby wrapper to consume the Sepomex API at [http://sepomex-api.herokuapp.com/api/v1/zip_codes](http://sepomex-api.herokuapp.com/api/v1/zip_codes)
 
-TODO: Delete this and the text above, and describe your gem
+## Table of contents
+- [Quick start](#quick-start)
+- [Usage](#usage)
+- [Bug tracker & feature request](#bug-tracker-&-feature-request) 
+- [Development](#development)
+- [Contributing](#contributing)
+- [Heroes](#heroes)
+- [License](#license)
 
-## Installation
+## Quick Start
 
 Add this line to your application's Gemfile:
 
@@ -14,15 +21,38 @@ gem 'sepomex'
 
 And then execute:
 
-    $ bundle
+```console
+% bundle
+```
 
 Or install it yourself as:
 
-    $ gem install sepomex
+```
+% gem install sepomex
+```
 
 ## Usage
 
-TODO: Write usage instructions here
+```ruby
+zip_codes = Sepomex::ZipCode.all
+
+=> [ #<Sepomex::ZipCode id=1, d_codigo="01000", d_asenta="San Ángel", d_tipo_asenta="Colonia", d_mnpio="Álvaro Obregón", d_estado="Distrito Federal", d_ciudad="Ciudad de México", d_cp="01001", c_estado="09", c_oficina="01001", c_cp="", c_tipo_asenta="09", c_mnpio="010", id_asenta_cpcons="0001", d_zona="Urbano", c_cve_ciudad="01">, 
+	 #<Sepomex::ZipCode id=2...]
+```
+
+You can specify the page to request as an option on the method.
+
+```ruby
+zip_codes = Sepomex::ZipCode.all(page: 2)
+
+=> [ #<Sepomex::ZipCode id=51, d_codigo="01000", d_asenta="San Ángel", d_tipo_asenta="Colonia", d_mnpio="Álvaro Obregón", d_estado="Distrito Federal", d_ciudad="Ciudad de México", d_cp="01001", c_estado="09", c_oficina="01001", c_cp="", c_tipo_asenta="09", c_mnpio="010", id_asenta_cpcons="0001", d_zona="Urbano", c_cve_ciudad="01">, 
+	 #<Sepomex::ZipCode id=52...]
+```
+
+## Bug tracker & feature request
+
+Have a bug or a feature request? [Please open a new issue](https://github.com/IcaliaLabs/sepomex-rb/issues). Before opening any issue, please search for existing issues.
+
 
 ## Development
 
@@ -37,3 +67,21 @@ To install this gem onto your local machine, run `bundle exec rake install`. To
 3. Commit your changes (`git commit -am 'Add some feature'`)
 4. Push to the branch (`git push origin my-new-feature`)
 5. Create a new Pull Request
+
+## Heroes
+
+**Abraham Kuri**
+
++ [http://twitter.com/kurenn](http://twitter.com/kurenn)
++ [http://github.com/kurenn](http://github.com/kurenn)
++ [http://klout.com/#/kurenn](http://klout.com/#/kurenn)
+
+**Oscar Elizondo**
+
++ [http://twitter.com/oehinojosa](http://twitter.com/oehinojosa)
++ [http://github.com/oelizondo](http://github.com/oelizondo)
+
+
+## Copyright and license
+
+Code and documentation copyright 2015 Icalia Labs. Code released under [the MIT license](LICENSE).

data/lib/sepomex/collection.rb

@@ -0,0 +1,17 @@
+module Sepomex
+  class Collection
+    attr_reader :total_pages, :total_objects, :per_page, :collection
+
+    def initialize(attributes = {})
+      @total_pages = attributes["total_pages"]
+      @total_objects = attributes["total_objects"]
+      @per_page = attributes["per_page"]
+      @collection = []
+    end
+
+    def method_missing(name, *args, &block)
+      @collection.send(name, *args, &block)
+    end
+
+  end
+end

data/lib/sepomex/version.rb

@@ -1,3 +1,3 @@
 module Sepomex
-  VERSION = "0.1.0"
+  VERSION = "0.2.0"
 end

data/lib/sepomex/zip_code.rb

@@ -1,4 +1,5 @@
 require 'sepomex/errors'
+require 'sepomex/collection'
 
 module Sepomex
   class ZipCode < OpenStruct
@@ -7,10 +8,17 @@ module Sepomex
     base_uri "sepomex-api.herokuapp.com/api/v1"
 
     def self.all(options = {})
+
       response = get("/zip_codes", { query: options })
 
       if response.success?
-        response["zip_codes"].map { |attributes| new(attributes) }
+        zip_codes = Sepomex::Collection.new(response["meta"]["pagination"])
+
+        response["zip_codes"].each do |attributes|
+          zip_codes << new(attributes)
+        end
+
+        zip_codes
       else
         raise_exception(response.code, response.body)
       end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: sepomex
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Abraham Kuri
@@ -86,6 +86,7 @@ files:
 - bin/console
 - bin/setup
 - lib/sepomex.rb
+- lib/sepomex/collection.rb
 - lib/sepomex/errors.rb
 - lib/sepomex/version.rb
 - lib/sepomex/zip_code.rb