epok 0.1.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 387ff0cf39fe626399e0c9e3c3100403040a9b632c7d2a6f0b32a7831bd5fe35
+  data.tar.gz: 892468b7a7ac3cd9663e04f9aec7bdd241570db8b05c9b3f6c5baa3f0c1b0f0a
+SHA512:
+  metadata.gz: b300e878806a3cf7ebf3336eaae481e55576ac89e5677d1b177ef6c42e2e40a59368893aaeb34e5f78e168c437bb1f0507496900f133c8b9d6652995a0bcc52a
+  data.tar.gz: f79a5fab0614a5cbd6a146cff6693a5ffc195d9bff4d04d2551d06f76103d46ea5565e6f4a7a3efcf1b2e28cebe71071d7c228ab07905dab259b5146907a7e17

data/.gitignore

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

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at arzezak@gmail.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,5 @@
+source "https://rubygems.org"
+
+git_source(:github) { |repo_name| "https://github.com/#{repo_name}" }
+
+gemspec

data/Gemfile.lock

@@ -0,0 +1,47 @@
+PATH
+  remote: .
+  specs:
+    epok (0.1.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    addressable (2.6.0)
+      public_suffix (>= 2.0.2, < 4.0)
+    ansi (1.5.0)
+    builder (3.2.3)
+    byebug (11.0.1)
+    crack (0.4.3)
+      safe_yaml (~> 1.0.0)
+    hashdiff (0.3.9)
+    minitest (5.11.3)
+    minitest-reporters (1.3.6)
+      ansi
+      builder
+      minitest (>= 5.0)
+      ruby-progressbar
+    public_suffix (3.0.3)
+    rake (10.5.0)
+    ruby-progressbar (1.10.0)
+    safe_yaml (1.0.5)
+    vcr (4.0.0)
+    webmock (3.5.1)
+      addressable (>= 2.3.6)
+      crack (>= 0.3.2)
+      hashdiff
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.17)
+  byebug
+  epok!
+  minitest (~> 5.0)
+  minitest-reporters (~> 1.3, >= 1.3.6)
+  rake (~> 10.0)
+  vcr (~> 4.0)
+  webmock (~> 3.5, >= 3.5.1)
+
+BUNDLED WITH
+   1.17.2

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2019 Ariel Rzezak
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,43 @@
+# Epok
+
+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/epok`. To experiment with that code, run `bin/console` for an interactive prompt.
+
+TODO: Delete this and the text above, and describe your gem
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'epok'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install epok
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/arzezak/epok. 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.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the Epok project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/arzezak/epok/blob/master/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,10 @@
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList["test/**/*_test.rb"]
+end
+
+task default: :test

data/bin/console

@@ -0,0 +1,9 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "epok"
+require "irb"
+
+@obelisco = Epok::Location.new(x: -58.381570, y: -34.603738)
+
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,7 @@
+#!/usr/bin/env bash
+
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install

data/epok.gemspec

@@ -0,0 +1,26 @@
+lib = File.expand_path("lib", __dir__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+
+require "epok/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "epok"
+  spec.version       = Epok::VERSION
+  spec.authors       = ["Ariel Rzezak"]
+  spec.email         = ["arzezak@gmail.com"]
+
+  spec.summary       = "GCBA EPOk wrapper."
+  spec.description   = "GCBA EPOk wrapper to query indexed geographic objects."
+  spec.homepage      = "https://github.com/arzezak/epok"
+  spec.license       = "MIT"
+
+  spec.files = `git ls-files`.split("\n")
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.17"
+  spec.add_development_dependency "minitest", "~> 5.0"
+  spec.add_development_dependency "minitest-reporters", "~> 1.3", ">= 1.3.6"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "vcr", "~> 4.0"
+  spec.add_development_dependency "webmock", "~> 3.5", ">= 3.5.1"
+end

data/lib/epok.rb

@@ -0,0 +1,17 @@
+require "epok/api"
+require "epok/collectable"
+require "epok/collection"
+require "epok/geocoder"
+require "epok/object"
+require "epok/search"
+require "epok/version"
+
+module Epok
+  def self.search(query)
+    Search.new(query)
+  end
+
+  def self.geocoder(location, categories)
+    Geocoder.new(location, categories)
+  end
+end

data/lib/epok/api.rb

@@ -0,0 +1,24 @@
+require "net/http"
+require "json"
+
+module Epok
+  class API
+    BASE_URL = "epok.buenosaires.gob.ar"
+
+    def self.object(id)
+      response = Net::HTTP.get_response(BASE_URL, "/getObjectContent/?id=#{id}")
+      JSON.parse(response.body)
+    end
+
+    def self.search(query)
+      response = Net::HTTP.get_response(BASE_URL, "/buscar/?texto=#{query}")
+      JSON.parse(response.body)["instancias"]
+    end
+
+    def self.geocoder(x, y, categories)
+      response = Net::HTTP.get_response(BASE_URL,
+        "/reverseGeocoderLugares/?x=#{x}&y=#{y}&categorias=#{categories}&radio=500")
+      JSON.parse(response.body)["instancias"]
+    end
+  end
+end

data/lib/epok/collectable.rb

@@ -0,0 +1,17 @@
+require "forwardable"
+
+module Epok
+  module Collectable
+    def self.included(base)
+      base.class_eval do
+        extend Forwardable
+
+        def_delegators :results, :entries, :first
+      end
+    end
+
+    def collection(object)
+      Collection.new object
+    end
+  end
+end

data/lib/epok/collection.rb

@@ -0,0 +1,23 @@
+module Epok
+  class Collection
+    include Enumerable
+
+    attr_reader :data
+
+    def initialize(data, id = "id")
+      @data = collection(data, id)
+    end
+
+    def each(&block)
+      data.each(&block)
+    end
+
+    private
+
+    def collection(data, id)
+      data.map do |item|
+        Object.new(item[id])
+      end
+    end
+  end
+end

data/lib/epok/geocoder.rb

@@ -0,0 +1,21 @@
+module Epok
+  Location = Struct.new(:x, :y, keyword_init: true)
+
+  class Geocoder
+    include Collectable
+
+    attr_reader :x, :y, :categories
+
+    def initialize(location, categories)
+      @x = location.x
+      @y = location.y
+      @categories = categories
+    end
+
+    private
+
+    def results
+      collection API.geocoder(x, y, categories)
+    end
+  end
+end

data/lib/epok/object.rb

@@ -0,0 +1,30 @@
+module Epok
+  class Object
+    attr_reader :id
+
+    def initialize(id)
+      @id = id
+    end
+
+    def name
+      content["Nombre"]
+    end
+
+    def normalized_address
+      object["direccionNormalizada"]
+    end
+
+    def content
+      object["contenido"].each_with_object({}) do |entry, hash|
+        name, value = entry.values_at("nombre", "valor")
+        hash[name] = value unless value.empty?
+      end
+    end
+
+    private
+
+    def object
+      API.object(id)
+    end
+  end
+end

data/lib/epok/search.rb

@@ -0,0 +1,17 @@
+module Epok
+  class Search
+    include Collectable
+
+    attr_reader :query
+
+    def initialize(query)
+      @query = query
+    end
+
+    private
+
+    def results
+      collection API.search(query)
+    end
+  end
+end

data/lib/epok/version.rb

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

data/test/epok/geocoder_test.rb

@@ -0,0 +1,29 @@
+require "test_helper"
+
+module Epok
+  class GeocoderTest < Minitest::Test
+    def setup
+      VCR.insert_cassette("geocoder", record: :new_episodes)
+    end
+
+    def teardown
+      VCR.eject_cassette("geocoder")
+    end
+
+    def test_that_geocoder_results_are_epok_objects
+      assert_instance_of Object, result
+    end
+
+    def test_that_a_single_geocoder_result_has_a_name
+      assert_match "Línea D", result.name
+    end
+
+    private
+
+    def result
+      obelisco = Location.new(x: -58.381570, y: -34.603738)
+      results = Geocoder.new(obelisco, "estaciones_de_subte")
+      results.first
+    end
+  end
+end

data/test/epok/object_test.rb

@@ -0,0 +1,41 @@
+require "test_helper"
+
+module Epok
+  class ObjectTest < Minitest::Test
+    def setup
+      VCR.insert_cassette("object")
+    end
+
+    def teardown
+      VCR.eject_cassette("object")
+    end
+
+    def test_that_an_object_has_a_name
+      assert_equal "Calesita del Parque Saavedra", object.name
+    end
+
+    def test_that_an_object_has_a_normalized_address
+      assert_equal "GARCIA DEL RIO y CONDE", object.normalized_address
+    end
+
+    def test_that_an_object_has_content
+      expected_content = {
+        "Nombre" => "Calesita del Parque Saavedra",
+        "Dirección" => "GARCIA DEL RIO y CONDE (CP 1430) - Saavedra - Comuna 12",
+        "Actividad Principal" => "Calesita",
+        "Días y Horarios" => "Todos los días de 10:00 a 12:00 y de 14:00 a 19:30.",
+        "Observaciones" => "Los días de lluvia la calesita se encuentra cerrada.",
+        "Sector" => "Privado",
+        "Público" => "Niños"
+      }
+
+      assert_equal expected_content, object.content
+    end
+
+    private
+
+    def object
+      Object.new("dependencias_culturales|1635")
+    end
+  end
+end

data/test/epok/search_test.rb

@@ -0,0 +1,28 @@
+require "test_helper"
+
+module Epok
+  class SearchTest < Minitest::Test
+    def setup
+      VCR.insert_cassette("search")
+    end
+
+    def teardown
+      VCR.eject_cassette("search")
+    end
+
+    def test_that_search_results_are_epok_objects
+      assert_instance_of Object, result
+    end
+
+    def test_that_a_single_search_result_has_a_name
+      assert_match "San Miguel de Garicoits", result.name
+    end
+
+    private
+
+    def result
+      results = Search.new("garicoits")
+      results.first
+    end
+  end
+end

data/test/epok_test.rb

@@ -0,0 +1,15 @@
+require "test_helper"
+
+class EpokTest < Minitest::Test
+  def test_that_it_has_a_version_number
+    refute_nil Epok::VERSION
+  end
+
+  def test_responds_to_search
+    assert_respond_to Epok, :search
+  end
+
+  def test_responds_to_geocoder
+    assert_respond_to Epok, :geocoder
+  end
+end

data/test/test_helper.rb

@@ -0,0 +1,13 @@
+$LOAD_PATH.unshift File.expand_path("../lib", __dir__)
+
+require "epok"
+require "minitest/autorun"
+require "minitest/reporters"
+require "vcr"
+
+Minitest::Reporters.use!
+
+VCR.configure do |config|
+  config.cassette_library_dir = "test/fixtures"
+  config.hook_into :webmock
+end

metadata

@@ -0,0 +1,162 @@
+--- !ruby/object:Gem::Specification
+name: epok
+version: !ruby/object:Gem::Version
+  version: 0.1.1
+platform: ruby
+authors:
+- Ariel Rzezak
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2019-04-23 00:00:00.000000000 Z
+dependencies:
+- !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: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+- !ruby/object:Gem::Dependency
+  name: minitest-reporters
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.3.6
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.3.6
+- !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: vcr
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.5'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.5.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.5'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.5.1
+description: GCBA EPOk wrapper to query indexed geographic objects.
+email:
+- arzezak@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- epok.gemspec
+- lib/epok.rb
+- lib/epok/api.rb
+- lib/epok/collectable.rb
+- lib/epok/collection.rb
+- lib/epok/geocoder.rb
+- lib/epok/object.rb
+- lib/epok/search.rb
+- lib/epok/version.rb
+- test/epok/geocoder_test.rb
+- test/epok/object_test.rb
+- test/epok/search_test.rb
+- test/epok_test.rb
+- test/test_helper.rb
+homepage: https://github.com/arzezak/epok
+licenses:
+- MIT
+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.1
+signing_key: 
+specification_version: 4
+summary: GCBA EPOk wrapper.
+test_files: []