inegi_ruby 0.1.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 6496d569a6a61b9b87893b678cc84004851cd0cb
+  data.tar.gz: fec85f48da9ce9da86fe8415a4cccec74f3df811
+SHA512:
+  metadata.gz: fef588e3a1d6d881e72e2d179cb3da32e9da7c5e0b018202b6f158b5daadfa5e31bbd797d7821fb93102659ece316287627f7988c30823eb877071aa53553e7f
+  data.tar.gz: da2af27f48fbcdadbde46539ec365d21a1f5f954fcfc1672d94eed77055d36af212592e91e28894bb7f99f22a847a515623d7885ec89912fd8d543039feceb45

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in inegi_ruby.gemspec
+gemspec

data/README.md

@@ -0,0 +1,60 @@
+# inegi_ruby
+
+Inegifacil's REST service wrapper for Ruby apps
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'inegi_ruby'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install inegi_ruby
+
+## Usage
+
+```ruby
+inegi = Inegi::Client.new
+
+# Returns information for aggregated Mexican population
+puts inegi.indexes "1002000001"
+# {
+#   indicator: "1002000001",
+#   values: [
+#     {
+#       period: "1990",
+#       value: "91829",
+#       units: "Número de personas"
+#     },
+#     ...
+#   ]
+# }
+
+# Returns information for population in specific location (Puebla)
+puts inegi.indexes "1002000001", "21000"
+# {
+#   indicator: "1002000001",
+#   values: [
+#     {
+#       period: "1990",
+#       value: "9182",
+#       units: "Número de personas"
+#     },
+#     ...
+#   ]
+# }
+```
+
+## Changelog
+
+#### 0.1.0
+* Get indexes for an indicator
+* `#indexes` accepts both an indicator and an optional location
+* Indicators and locations are validated

data/Rakefile

@@ -0,0 +1,10 @@
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new do |task|
+  task.libs.push "test"
+  task.pattern = "test/**/*_test.rb"
+  task.warning = false
+end
+
+task :default => :test

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "inegi_ruby"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/inegi_ruby.gemspec

@@ -0,0 +1,33 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'inegi_ruby/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "inegi_ruby"
+  spec.version       = InegiRuby::VERSION
+  spec.authors       = ["Daniel Olivares"]
+  spec.email         = ["danieloddl2@hotmail.com"]
+
+  spec.summary       = %q{INEGI's REST service wrapper}
+  spec.description   = %q{INEGI's REST service wrapper}
+  spec.homepage      = "https://github.com/K1N5L4Y3R/inegi_ruby"
+
+  # Prevent pushing this gem to RubyGems.org. To allow pushes either set the 'allowed_push_host'
+  # to allow pushing to a single host or delete this section to allow pushing to any host.
+  if spec.respond_to?(:metadata)
+    spec.metadata['allowed_push_host'] = "https://rubygems.org"
+  else
+    raise "RubyGems 2.0 or newer is required to protect against public gem pushes."
+  end
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.12"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "minitest", "~> 5.9"
+  spec.add_development_dependency "httparty", "~> 0.14.0"
+end

data/lib/inegi_ruby.rb

@@ -0,0 +1,74 @@
+require "inegi_ruby/version"
+require "httparty"
+
+module Inegi
+  class Client
+    include HTTParty
+    
+    base_uri "http://inegifacil.com/rest/indice"
+    
+    ##
+    # Validates that an indicator adheres to INEGI's format
+    # It looks like indicators have a format of 10 digits
+    # @example
+    #   validate_indicator("5300000041")  # true
+    #   validate_indicator("53000000412") # false
+    #   validate_indicator("")            # false
+    #   validate_indicator("a")           # false
+    # @param indicator [String] Indicator to be evaluated
+    def self.validate_indicator(indicator)
+      i_regex = /\A\d{10}\z/
+      indicator =~ i_regex || raise(ArgumentError.new("Given indicator is not valid"))
+    end
+    
+    # Validates that a location adheres to INEGI's format
+    # It looks like locations have a format of 5 digits
+    # @example
+    #   validate_indicator("53000")       # true
+    #   validate_indicator("53000000412") # false
+    #   validate_indicator("")            # false
+    #   validate_indicator("a")           # false
+    # @param location [String] Location to be evaluated
+    def self.validate_location(location)
+      l_regex = /\A\d{5}\z/
+      location =~ l_regex || raise(ArgumentError.new("Given location is not valid"))
+    end
+    
+    ##
+    # After validating indicator, call Inegifacil's service and return indexes.
+    # @example
+    #   indexes("5300000041") # HTTParty::Response[...]
+    # @param indicator [String] 10 digits indicator
+    # @param location [String] 5 digits location indicator
+    def indexes(indicator, location = nil)
+      self.class.validate_indicator indicator
+      self.class.validate_location location if location
+      path = "/#{indicator}/#{location}"
+      indexes = self.class.get path
+      self.class.format_indexes indexes
+    end
+    
+    ##
+    # From a hash with Inegifacil's structure, return a more readable one
+    # @example
+    #   hash = { "header": { "INDICADOR": "XXXXXXXXXX" },
+    #            "indices": [{ "TIME_PERIOD": "YYYY", "OBS_VALUE": "Z" }] }
+    # 
+    #   format_indexes(hash) # { indicator: "XXXXXXXXXX", values: [..] }
+    #                        # +values+ contains +period+, +value+ and +units+
+    # @param hash [Hash] A hash containing results from service
+    # @see http://inegifacil.com/rest/indice/1002000001
+    def self.format_indexes(hash)
+      result = { indicator: hash["header"]["INDICADOR"] }
+      values = hash["indices"].map do |v|
+        {
+          period: v["TIME_PERIOD"],
+          value: v["OBS_VALUE"],
+          units: v["OBS_UNIT"]
+        }
+      end
+      values = { values: values }
+      result.merge values
+    end
+  end
+end

data/lib/inegi_ruby/version.rb

@@ -0,0 +1,3 @@
+module InegiRuby
+  VERSION = "0.1.1"
+end

metadata

@@ -0,0 +1,109 @@
+--- !ruby/object:Gem::Specification
+name: inegi_ruby
+version: !ruby/object:Gem::Version
+  version: 0.1.1
+platform: ruby
+authors:
+- Daniel Olivares
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2016-09-15 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.12'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.12'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.9'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.9'
+- !ruby/object:Gem::Dependency
+  name: httparty
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.14.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.14.0
+description: INEGI's REST service wrapper
+email:
+- danieloddl2@hotmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- inegi_ruby.gemspec
+- lib/inegi_ruby.rb
+- lib/inegi_ruby/version.rb
+homepage: https://github.com/K1N5L4Y3R/inegi_ruby
+licenses: []
+metadata:
+  allowed_push_host: https://rubygems.org
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.5.1
+signing_key: 
+specification_version: 4
+summary: INEGI's REST service wrapper
+test_files: []