dof 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 71cd14922fb4ae55bce6c6bb13a4ec712cd6b3eada9fdc4d1b60dd3e92910bf5
+  data.tar.gz: 0dd8e99c443220e7c30dd80d0533bc1990291556347ec651066ff572e72c0ced
+SHA512:
+  metadata.gz: 18869f525f4370ac4ea2c3062dac09e77def696528205b9d30bccec65861a76b14a744ed66c50ce5ce81b06c007e938557e1bfdfaca48811d1795a943e229ebd
+  data.tar.gz: b112b02349dcd2f3f55c8d8c91c85bab99b28b924eaba939b440361a31202e6f84fb923c9c23ef863088d82f209fbf9aaff72a5693aacca91572dde4738c2958

data/.github/workflows/ruby.yml

@@ -0,0 +1,67 @@
+# This workflow uses actions that are not certified by GitHub.
+# They are provided by a third-party and are governed by
+# separate terms of service, privacy policy, and support
+# documentation.
+# This workflow will download a prebuilt Ruby version, install dependencies and run tests with Rake
+# For more information see: https://github.com/marketplace/actions/setup-ruby-jruby-and-truffleruby
+
+name: Ruby
+
+on:
+  push:
+    branches: [ master ]
+  pull_request:
+    branches: [ master ]
+
+jobs:
+  test:
+
+    runs-on: ubuntu-latest
+
+    steps:
+    - uses: actions/checkout@v2
+    - name: Set up Ruby
+    # To automatically get bug fixes and new Ruby versions for ruby/setup-ruby,
+    # change this to (see https://github.com/ruby/setup-ruby#versioning):
+    # uses: ruby/setup-ruby@v1
+      uses: ruby/setup-ruby@ec106b438a1ff6ff109590de34ddc62c540232e0
+      with:
+        ruby-version: 2.6
+    - name: Install dependencies
+      run: bundle install
+    - name: Run tests
+      run: bundle exec rake
+
+  build:
+    name: Build + Publish
+    runs-on: ubuntu-latest
+
+    steps:
+    - uses: actions/checkout@v2
+    - name: Set up Ruby 2.6
+      uses: actions/setup-ruby@v1
+      with:
+        ruby-version: 2.6.x
+
+    - name: Publish to GPR
+      run: |
+        mkdir -p $HOME/.gem
+        touch $HOME/.gem/credentials
+        chmod 0600 $HOME/.gem/credentials
+        printf -- "---\n:github: ${GEM_HOST_API_KEY}\n" > $HOME/.gem/credentials
+        gem build *.gemspec
+        gem push --KEY github --host https://rubygems.pkg.github.com/${OWNER} *.gem
+      env:
+        GEM_HOST_API_KEY: "Bearer ${{secrets.GITHUB_TOKEN}}"
+        OWNER: ${{ github.repository_owner }}
+
+    - name: Publish to RubyGems
+      run: |
+        mkdir -p $HOME/.gem
+        touch $HOME/.gem/credentials
+        chmod 0600 $HOME/.gem/credentials
+        printf -- "---\n:rubygems_api_key: ${GEM_HOST_API_KEY}\n" > $HOME/.gem/credentials
+        gem build *.gemspec
+        gem push *.gem
+      env:
+        GEM_HOST_API_KEY: "${{secrets.RUBYGEMS_AUTH_TOKEN}}"

data/.gitignore

@@ -0,0 +1,11 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.travis.yml

@@ -0,0 +1,7 @@
+---
+sudo: false
+language: ruby
+cache: bundler
+rvm:
+  - 2.5.1
+before_install: gem install bundler -v 1.17.3

data/DOF.gemspec

@@ -0,0 +1,33 @@
+
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "DOF/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "dof"
+  spec.version       = DOF::VERSION
+  spec.authors       = ["Yellowme"]
+  spec.email         = ["hola@yellowme.mx"]
+
+  spec.summary       = %q{A simple service to consume Mexican DOF data}
+  spec.homepage      = "https://github.com/yellowme/DOF"
+
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "faraday", "~> 1.0.0"
+
+  spec.add_development_dependency "bundler", "~> 1.17"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency 'app_version_tasks'
+  spec.add_development_dependency 'simplecov', '~> 0.17'
+  spec.add_development_dependency 'webmock', '~> 3.7'
+end

data/Gemfile

@@ -0,0 +1,6 @@
+source "https://rubygems.org"
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in DOF.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,61 @@
+PATH
+  remote: .
+  specs:
+    Dof (1.0.0)
+      faraday (~> 1.0.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    addressable (2.7.0)
+      public_suffix (>= 2.0.2, < 5.0)
+    app_version_tasks (0.2.5)
+      git (~> 1.3)
+    crack (0.4.4)
+    diff-lcs (1.4.4)
+    docile (1.3.2)
+    faraday (1.0.1)
+      multipart-post (>= 1.2, < 3)
+    git (1.7.0)
+      rchardet (~> 1.8)
+    hashdiff (1.0.1)
+    multipart-post (2.1.1)
+    public_suffix (4.0.6)
+    rake (10.5.0)
+    rchardet (1.8.0)
+    rspec (3.9.0)
+      rspec-core (~> 3.9.0)
+      rspec-expectations (~> 3.9.0)
+      rspec-mocks (~> 3.9.0)
+    rspec-core (3.9.3)
+      rspec-support (~> 3.9.3)
+    rspec-expectations (3.9.2)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.9.0)
+    rspec-mocks (3.9.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.9.0)
+    rspec-support (3.9.3)
+    simplecov (0.19.0)
+      docile (~> 1.1)
+      simplecov-html (~> 0.11)
+    simplecov-html (0.12.3)
+    webmock (3.9.1)
+      addressable (>= 2.3.6)
+      crack (>= 0.3.2)
+      hashdiff (>= 0.4.0, < 2.0.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  Dof!
+  app_version_tasks
+  bundler (~> 1.17)
+  rake (~> 10.0)
+  rspec (~> 3.0)
+  simplecov (~> 0.17)
+  webmock (~> 3.7)
+
+BUNDLED WITH
+   1.17.3

data/README.md

@@ -0,0 +1,76 @@
+# DOF
+A simple gem to interact with the Mexican DOF open data service
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'dof'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install dof
+
+## Usage
+
+Add a new initializer and add the following lines
+```ruby
+require "DOF"
+
+DOF.config do |c|
+  c.base_uri = "https://sidofqa.segob.gob.mx/dof/sidof/"
+end
+```
+
+### Querying the current USD exchange rate
+
+To get the current (daily) exchange rate call `USD_exchange_rate`
+
+```ruby
+DOF::Indicator.USD_exchange_rate
+```
+
+This will return an `RequestResponse` object with the following attributes:
+
+```ruby
+# An array of indicator objects
+:indicators
+# A request response confirmation
+:response_code
+# response status eg: 200/500
+:response_status
+# number of indicators found
+:total_indicators
+```
+
+### Querying the current UDIS exchange rate
+
+To get the current (daily) exchange rate call `UDIS_exchange_rate`
+
+```ruby
+DOF::Indicator.UDIS_exchange_rate
+```
+
+### Querying indicators by date range
+
+You can call `USD_exchange_rate` and `UDIS_exchange_rate` with date params
+
+```ruby
+DOF::Indicator.USD_exchange_rate(date: initial_date, end_date: end_date)
+```
+
+The accepted date formats are:
+* `String` in *mm/dd/YYYY* format
+* `String` in *mm-dd-YYYY* format
+* `String` in *mm.dd.YYYY* format
+* `Date` type, eg: *Date.today*
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/yellowme/DOF.

data/Rakefile

@@ -0,0 +1,14 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+require 'app_version_tasks'
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec
+
+spec = Gem::Specification.find_by_name 'app_version_tasks'
+load "#{spec.gem_dir}/lib/tasks/app_version_tasks.rake"
+AppVersionTasks.configure do |config|
+  config.application_name = 'dof'
+  config.version_file_path = File.join('lib', 'DOF', 'version.rb')
+end

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "DOF"
+
+# 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(__FILE__)

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/lib/DOF.rb

@@ -0,0 +1,30 @@
+require "DOF/version"
+require "DOF/connection"
+require "DOF/client"
+require "DOF/endpoints"
+require "DOF/indicator"
+require "DOF/indicator_codes"
+require "DOF/responses/request_response"
+require "DOF/responses/indicator_response"
+require "DOF/date_formatter"
+require "DOF/errors/base_error"
+require "DOF/errors/precondition_failed"
+require "DOF/errors/network_error"
+
+module DOF
+  def self.config
+    yield self
+  end
+
+  def self.version
+    @version
+  end
+
+  def self.base_uri
+    @base_uri
+  end
+
+  def self.base_uri=(base_uri)
+    @base_uri = base_uri
+  end
+end

data/lib/DOF/client.rb

@@ -0,0 +1,10 @@
+module DOF
+  module Client 
+    def self.get(path:, body: nil, headers: {})
+      response = DOF.connection.get path, body, headers
+      JSON.parse(response.body)
+    rescue Faraday::ConnectionFailed, Faraday::TimeoutError
+      raise DOF::Errors::NetworkError
+    end
+  end
+end

data/lib/DOF/connection.rb

@@ -0,0 +1,10 @@
+require 'faraday'
+module DOF
+  def self.connection
+    Faraday.new(url: DOF.base_uri ) do |faraday|
+      faraday.response :logger
+      faraday.adapter Faraday.default_adapter
+      faraday.use Faraday::Response::RaiseError
+    end
+  end
+end

data/lib/DOF/date_formatter.rb

@@ -0,0 +1,15 @@
+module DOF
+  module DateFormatter
+    DATE_FORMAT = '^(?:(?:31(\/|-|\.)(?:0?[13578]|1[02]))\1|(?:(?:29|30)(\/|-|\.)(?:0?[13-9]|1[0-2])\2))(?:(?:1[6-9]|[2-9]\d)?\d{2})$|^(?:29(\/|-|\.)0?2\3(?:(?:(?:1[6-9]|[2-9]\d)?(?:0[48]|[2468][048]|[13579][26])|(?:(?:16|[2468][048]|[3579][26])00))))$|^(?:0?[1-9]|1\d|2[0-8])(\/|-|\.)(?:(?:0?[1-9])|(?:1[0-2]))\4(?:(?:1[6-9]|[2-9]\d)?\d{2})$'
+    
+    def self.format(date)
+      formatted_date = ''
+
+      if ((date.is_a? String) && date.match(DATE_FORMAT)) || (date.is_a? Date)
+        formatted_date = Date.parse(date.to_s).strftime("%d-%m-%Y")
+      else
+        raise Errors::PreconditionFailed.new("The date has incorrect format")
+      end
+    end
+  end
+end

data/lib/DOF/endpoints.rb

@@ -0,0 +1,5 @@
+module DOF
+  module Endpoints
+    INDICATORS = "indicadores"
+  end
+end

data/lib/DOF/errors/base_error.rb

@@ -0,0 +1,13 @@
+module DOF
+  module Errors
+    class BaseError < StandardError
+      attr_accessor :code, :detail
+      
+      def initialize(message = '', code: '', detail: '')
+        @code = code
+        @detail = detail
+        super("#{code} #{message}")
+      end
+    end
+  end
+end

data/lib/DOF/errors/network_error.rb

@@ -0,0 +1,5 @@
+module DOF
+  module Errors
+    class NetworkError < BaseError; end
+  end
+end

data/lib/DOF/errors/precondition_failed.rb

@@ -0,0 +1,5 @@
+module DOF
+  module Errors
+    class PreconditionFailed < BaseError; end
+  end
+end

data/lib/DOF/indicator.rb

@@ -0,0 +1,25 @@
+module DOF
+  class Indicator
+    class << self
+
+      def USD_exchange_rate(date: Date.today, end_date: date)
+        raw_response = get(Indicator_Codes::USD, date, end_date)
+        response = Responses::RequestResponse.new(raw_response)
+      end
+
+      def UDIS_exchange_rate(date: Date.today, end_date: date)
+        raw_response = get(Indicator_Codes::UDIS, date, end_date)
+        response = Responses::RequestResponse.new(raw_response)
+      end
+
+      private
+
+      def get(indicator, initial_date, end_date)
+        initial_date = DateFormatter.format(initial_date)
+        end_date = DateFormatter.format(end_date)
+
+        Client.get path: "#{Endpoints::INDICATORS}/#{indicator}/#{initial_date}/#{end_date}"
+      end
+    end
+  end
+end

data/lib/DOF/indicator_codes.rb

@@ -0,0 +1,6 @@
+module DOF
+  class Indicator_Codes
+    USD = "158".freeze
+    UDIS = "159".freeze
+  end
+end

data/lib/DOF/responses/indicator_response.rb

@@ -0,0 +1,20 @@
+require 'bigdecimal'
+
+module DOF
+  module Responses
+    class IndicatorResponse
+
+      attr_reader :indicador_code
+      attr_reader :indicador_type_code
+      attr_reader :date
+      attr_reader :value
+
+      def initialize(data)
+        @indicador_code = data["codIndicador"]
+        @indicador_type_code = data["codTipoIndicador"]
+        @date = data["fecha"]
+        @value = BigDecimal(data["valor"])
+      end
+    end    
+  end
+end

data/lib/DOF/responses/request_response.rb

@@ -0,0 +1,35 @@
+module DOF
+  module Responses
+    class RequestResponse
+      NO_ERROR_CODE = 200
+
+      attr_reader :indicators
+      attr_reader :response_code
+      attr_reader :response_status
+      attr_reader :total_indicators
+
+      def initialize(response)
+        parse_response(response)
+      end
+
+      def parse_response(response)
+        @response_code = response["messageCode"]
+        @response_status = response["response"]
+        @total_indicators = response["TotalIndicadores"]
+        @indicators = []
+
+        build_indicator(response["ListaIndicadores"])
+      end
+
+      def build_indicator(data)
+        data.each do |indicator|
+          @indicators << Responses::IndicatorResponse.new(indicator)
+        end
+      end
+
+      def successful?
+        @response_code == NO_ERROR_CODE
+      end
+    end    
+  end
+end

data/lib/DOF/version.rb

@@ -0,0 +1,3 @@
+module DOF
+  VERSION = "1.0.0"
+end

metadata

@@ -0,0 +1,164 @@
+--- !ruby/object:Gem::Specification
+name: dof
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Yellowme
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2020-10-08 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: faraday
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.0.0
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.17'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.17'
+- !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: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: app_version_tasks
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.17'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.17'
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.7'
+description: 
+email:
+- hola@yellowme.mx
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".github/workflows/ruby.yml"
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- DOF.gemspec
+- Gemfile
+- Gemfile.lock
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/DOF.rb
+- lib/DOF/client.rb
+- lib/DOF/connection.rb
+- lib/DOF/date_formatter.rb
+- lib/DOF/endpoints.rb
+- lib/DOF/errors/base_error.rb
+- lib/DOF/errors/network_error.rb
+- lib/DOF/errors/precondition_failed.rb
+- lib/DOF/indicator.rb
+- lib/DOF/indicator_codes.rb
+- lib/DOF/responses/indicator_response.rb
+- lib/DOF/responses/request_response.rb
+- lib/DOF/version.rb
+homepage: https://github.com/yellowme/DOF
+licenses: []
+metadata: {}
+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: []
+rubygems_version: 3.0.3
+signing_key: 
+specification_version: 4
+summary: A simple service to consume Mexican DOF data
+test_files: []