lolcation_client 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 360b216fb23e60e4142114dd41c50cab60876d0f
+  data.tar.gz: 15b66806c2d1f7492fbff90cacabc62fa62d0a5d
+SHA512:
+  metadata.gz: 442370035d2a77f49b6facc651836db1572681d4bde2b9cc291c93bdd7df193f08900aacc8c34af964f68a366646f092b840db5fb283c41af0f885885bde490f
+  data.tar.gz: db4d8b67f6234fc281b4f9a23a8450d48f1e12585cf426bf87268b886485c264bd37b8fc89a67af2fb9baaf1dab4d818f224736672b30a4638196e9bd038b34a

data/.gitignore

@@ -0,0 +1,18 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+TODO

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.4.0
+before_install: gem install bundler -v 1.15.1

data/CONTRIBUTING.md

@@ -0,0 +1,43 @@
+# Contributing
+
+We love pull requests. Here's a quick guide:
+
+1. Fork the repo.
+
+1. Create your feature branch (`git checkout -b my-new-feature`)
+
+1. Run the tests. We only take pull requests with passing tests, and it's great
+to know that you have a clean slate: `bundle && rake`
+
+1. Add a test for your change. Only refactoring and documentation changes
+require no new tests. If you are adding functionality or fixing a bug, we need
+a test!
+
+1. Make the test pass.
+
+1. Update [CHANGELOG.md](https://github.com/loldesign/lolcation_client/blob/master/CHANGELOG.md) with a brief description of your changes under the `unreleased` heading.
+
+1. Commit your changes (`git commit -am 'Added some feature'`)
+
+1. Push to the branch (`git push origin my-new-feature`)
+
+1. Create new Pull Request
+
+At this point you're waiting on us. We like to at least give you feedback, if not just
+accept it, within a few days, depending on our internal priorities.
+
+Some things that will increase the chance that your pull request is accepted is to follow the practices described on [Ruby style guide](https://github.com/bbatsov/ruby-style-guide), [Rails style guide](https://github.com/bbatsov/rails-style-guide) and [Better Specs](http://betterspecs.org/).
+
+## General rules
+
+- Version upgrade of gems should be done only via PR (without opening an issue before)
+- Features should be discussed on issues before opening a PR. If passed 15 days without interaction on the issue(a comment, a pull request) the issue will be closed.
+- Every PR of new features/gems should come with the specs/feature of the change
+
+## Removing gems
+
+Pah is an opinionated Rails template. All gems are our recommendations to recurring problems based on our experience. For example, when writing tests that need to access network we recommend using VCR and WebMock.
+If you want to make a PR to add/remove gem X, please follow the steps below:
+
+1. Make a PR to our blog and explain the gem's pros and cons, how to use, the tricks etc.
+1. Make a PR to remove gem X

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 Marcelo Barreto
+
+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,91 @@
+# LOLCATION CLIENT
+[![Build Status][travis_badge]][travis]
+[![RubyGems][gem_version_badge]][ruby_gems]
+[![Code Climate][code_climate_badge]][code_climate]
+[![Gemnasium][gemnasium_badge]][gemnasium]
+[![RubyGems][gem_downloads_badge]][ruby_gems]
+
+A Rails GEM to use Lolcation Service.
+
+## Getting started
+You can add it to your Gemfile with:
+
+gem 'lolcation_client'
+Then run bundle install
+
+Next, you need to run the generator:
+
+`$ rails generate lolcation:install`
+
+and
+
+```ruby
+  class LolcalizationModel < ApplicationRecord
+    extend LolcationClient
+  end
+```
+You can also define lolcation_custom_fields, so you can filter later when you need
+
+```ruby
+class LolcalizationModel < ApplicationRecord
+  extend LolcationClient
+
+  lolcation_custom_fields :foo, :bar, :baz
+end
+```
+
+`$ rails generate lolcation:migration MODEL`
+
+then run:
+
+`$ rails db:migrate`
+
+
+DO NOT FORGET TO SET UP YOUR LOLCATION TOKEN AT `config/lolcation.yml`
+
+## Versioning
+
+LOLCATION CLIENT follows the [Semantic Versioning](http://semver.org/) standard.
+
+## Issues
+
+If you have problems, please create a [Github Issue](https://github.com/loldesign/lolcation_client/issues).
+
+## Contributing
+
+Please see [CONTRIBUTING.md](https://github.com/loldesign/lolcation_client/blob/master/CONTRIBUTING.md) for details.
+
+## Maintainers
+
+- [Eduardo Zaghi](https://github.com/eduzera)
+- [Marcelo Barreto](https://github.com/marcelobarreto)
+- [Paulo Henrique Sacramento](https://github.com/henriquesacramento)
+
+## Release
+
+Follow this steps to release a new version of the gem.
+
+1. Test if everything is running ok;
+2. Change version of the gem on `VERSION` constant;
+3. Add the release date on the `CHANGELOG`;
+4. Do a commit "Bump version x.x.x", follow the semantic version;
+5. Run `$ rake release`, this will send the gem to the rubygems;
+6. Check if the gem is on the rubygems and the tags are correct on the github;
+
+## Made with love by LolDesign
+
+![LolDesign](http://novo.loldesign.com.br/wp-content/uploads/2015/12/LolDesign.svg)
+
+This gem was created and is maintained by [LolDesign](https://github.com/loldesign).
+
+
+[LolDesign]: http://loldesign.com.br
+[gem_version_badge]: http://img.shields.io/gem/v/lolcation_client.svg?style=flat
+[gem_downloads_badge]: http://img.shields.io/gem/dt/lolcation_client.svg?style=flat
+[ruby_gems]: http://rubygems.org/gems/lolcation_client
+[code_climate]: https://codeclimate.com/github/loldesign/lolcation_client
+[code_climate_badge]: http://img.shields.io/codeclimate/github/loldesign/lolcation_client.svg?style=flat
+[gemnasium]: https://gemnasium.com/loldesign/lolcation_client
+[gemnasium_badge]: http://img.shields.io/gemnasium/loldesign/lolcation_client.svg?style=flat
+[travis]: https://travis-ci.org/loldesign/lolcation_client
+[travis_badge]: http://img.shields.io/travis/loldesign/lolcation_client/master.svg?style=flat

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "lolcation_client"
+
+# 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/generators/lolcation_client/install_generator.rb

@@ -0,0 +1,16 @@
+require 'rails/generators'
+require 'rails/generators/base'
+
+module LolcationClient
+  module Generators
+    class InstallGenerator < Rails::Generators::Base
+      source_root File.expand_path('../templates', __FILE__)
+
+      def copy_yml_file
+        template "lolcation.yml", "config/lolcation.yml"
+
+        puts "Do not forget to change your token at config/lolcation.yml"
+      end
+    end
+  end
+end

data/lib/generators/lolcation_client/migration_generator.rb

@@ -0,0 +1,47 @@
+require 'rails/generators'
+require 'rails/generators/base'
+
+module LolcationClient
+  module Generators
+    class MigrationGenerator < Rails::Generators::NamedBase
+      source_root File.expand_path('../templates', __FILE__)
+      argument :attributes, type: :array, default: [], banner: "field:type field:type"
+
+      def copy_migration
+        generate_model_if_does_not_exists
+        template "migration.rb", "db/migrate/#{Time.zone.now.strftime("%Y%m%d%H%M%S")}_add_lolcation_to_#{table_name}.rb"
+      end
+
+      private
+
+      def model_exists?
+        File.exist?(File.join(destination_root, model_path))
+      end
+
+      def migration_exists?(table_name)
+        Dir.glob("#{File.join(destination_root, migration_path)}/[0-9]*_*.rb").grep(/\d+_add_lolcalization_to_#{table_name}.rb$/).first
+      end
+
+      def migration_path
+        @migration_path ||= File.join("db", "migrate")
+      end
+
+      def model_path
+        @model_path ||= File.join("app", "models", "#{file_path}.rb")
+      end
+
+      def attributes_and_types
+        attributes.map do |attribute|
+          "#{attribute.name}:#{attribute.type}"
+        end.join(' ')
+      end
+
+      def generate_model_if_does_not_exists
+        unless model_exists?
+          system "rails generate model #{name} #{attributes_and_types} --force"
+          sleep 1
+        end
+      end
+    end
+  end
+end

data/lib/generators/lolcation_client/templates/lolcation.yml

@@ -0,0 +1,8 @@
+development:
+  token: 'Insert your token here'
+  sandbox: true
+staging:
+  token: 'Insert your token here'
+  sandbox: true
+production:
+  token: 'Insert your token here'

data/lib/generators/lolcation_client/templates/migration.rb

@@ -0,0 +1,15 @@
+class AddLolcationTo<%= table_name.camelize %> < ActiveRecord::Migration
+  def self.up
+    change_table :<%= table_name %> do |t|
+      t.float :lolcation_latitude
+      t.float :lolcation_longitude
+      t.string :lolcation_id
+      t.string :lolcation_name
+      t.string :lolcation_address_street
+      t.string :lolcation_address_neighborhood
+      t.string :lolcation_address_city
+      t.string :lolcation_address_state
+      t.string :lolcation_address_number
+    end
+  end
+end

data/lib/lolcation_client/configurations.rb

@@ -0,0 +1,5 @@
+module LolcationClient
+  module Configurations
+    URL = "http://localhost:3000/api/v1/localizations"
+  end
+end

data/lib/lolcation_client/custom_fields.rb

@@ -0,0 +1,7 @@
+module LolcationClient
+  module CustomFields
+    def lolcation_custom_fields(*params)
+      @lolcation_custom_fields ||= params
+    end
+  end
+end

data/lib/lolcation_client/interceptor.rb

@@ -0,0 +1,94 @@
+require "faraday"
+require_relative "configurations"
+
+module LolcationClient
+  module Interceptor
+    def self.included(model)
+      model.send(:after_validation) do
+        if self.lolcation_id.present?
+          response = patch_on_lolcation_server
+        else
+          response = post_on_lolcation_server
+        end
+
+        parsed_response = JSON.parse(response.body)
+        if parsed_response["error"]
+          self.errors.add(:base, parsed_response["error"])
+          false
+        elsif parsed_response['localization']
+          self.lolcation_id = parsed_response["localization"]["objectId"]
+        else
+          parsed_response.map {|error, message| self.errors.add("lolcation_#{error}", message[0])}
+          false
+        end
+      end
+    end
+
+    private
+
+    def configs
+      Rails.application.config_for(:lolcation)
+    end
+
+    def token
+      configs["token"]
+    end
+
+    def sandbox?
+      configs["sandbox"] || false
+    end
+
+    def custom_fields
+      self.class.try(:lolcation_custom_fields) || []
+    end
+
+    def set_custom_fields
+      attributes = custom_fields.map {|attribute| {attribute => self.try(attribute)}}
+      hash = {}
+      attributes.each do |attribute|
+        attribute.each do |key, value|
+          hash[key] = value
+        end
+      end
+
+      hash
+    end
+
+    def prepare_object_to_post
+      {
+        localization: {
+          latitude: self.try(:lolcation_latitude),
+          longitude: self.try(:lolcation_longitude),
+          name: self.try(:lolcation_name),
+          address_street: self.try(:lolcation_address_street),
+          address_neighborhood: self.try(:lolcation_address_neighborhood),
+          address_city: self.try(:lolcation_address_city),
+          address_state: self.try(:lolcation_address_state),
+          address_number: self.try(:lolcation_address_number),
+          custom_fields: set_custom_fields
+        },
+        sandbox: sandbox?
+      }
+    end
+
+    def post_on_lolcation_server
+      url = LolcationClient::Configurations::URL
+      conn = Faraday.new(url: url)
+      conn.post do |r|
+        r.headers["X-Token"] = token
+        r.headers["Content-Type"] = "application/json"
+        r.body = prepare_object_to_post.to_json
+      end
+    end
+
+    def patch_on_lolcation_server
+      url = LolcationClient::Configurations::URL
+      conn = Faraday.new(url: "#{url}/#{self.lolcation_id}")
+      conn.put do |r|
+        r.headers["X-Token"] = token
+        r.headers["Content-Type"] = "application/json"
+        r.body = prepare_object_to_post.to_json
+      end
+    end
+  end
+end

data/lib/lolcation_client/version.rb

@@ -0,0 +1,3 @@
+module LolcationClient
+  VERSION = "0.1.0"
+end

data/lib/lolcation_client.rb

@@ -0,0 +1,12 @@
+require "lolcation_client/version"
+
+module LolcationClient
+  autoload :Interceptor,      "lolcation_client/interceptor"
+  autoload :Configurations,   "lolcation_client/configurations"
+  autoload :CustomFields,     "lolcation_client/custom_fields"
+
+  def self.extended(base)
+    base.include LolcationClient::Interceptor
+    base.extend  LolcationClient::CustomFields
+  end
+end

data/lolcation_client.gemspec

@@ -0,0 +1,38 @@
+# coding: utf-8
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "lolcation_client/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "lolcation_client"
+  spec.version       = LolcationClient::VERSION
+  spec.authors       = ["Eduardo Zaghi", "Marcelo Barreto"]
+	spec.email         = ["eduardo@loldesign.com.br", "marcelobarretojunior@gmail.com"]
+
+  spec.summary       = %q{Write a short summary, because Rubygems requires one.}
+  spec.description   = %q{Write a longer description or delete this line.}
+  spec.homepage      = "https://github.com/loldesign/lolcation_client"
+  spec.license       = "MIT"
+
+  # 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 do |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_development_dependency "bundler", "~> 1.15"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_dependency('activesupport', '>= 3.2')
+  spec.add_dependency('faraday', '>= 0.12')
+end

metadata

@@ -0,0 +1,137 @@
+--- !ruby/object:Gem::Specification
+name: lolcation_client
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Eduardo Zaghi
+- Marcelo Barreto
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2017-07-04 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.15'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.15'
+- !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: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.2'
+- !ruby/object:Gem::Dependency
+  name: faraday
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0.12'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0.12'
+description: Write a longer description or delete this line.
+email:
+- eduardo@loldesign.com.br
+- marcelobarretojunior@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CONTRIBUTING.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/generators/lolcation_client/install_generator.rb
+- lib/generators/lolcation_client/migration_generator.rb
+- lib/generators/lolcation_client/templates/lolcation.yml
+- lib/generators/lolcation_client/templates/migration.rb
+- lib/lolcation_client.rb
+- lib/lolcation_client/configurations.rb
+- lib/lolcation_client/custom_fields.rb
+- lib/lolcation_client/interceptor.rb
+- lib/lolcation_client/version.rb
+- lolcation_client.gemspec
+homepage: https://github.com/loldesign/lolcation_client
+licenses:
+- MIT
+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: Write a short summary, because Rubygems requires one.
+test_files: []