emapic_consul 0.1.5.4 → 0.1.5.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: a335563539e21af4f8170ea1be9828ec39307752
-  data.tar.gz: 4164a2be411a7c5b3d57b039cd0d2fed1b9032b5
+  metadata.gz: 1af07728bb87ecdec7d331c2f91fc59d8cfd7f1f
+  data.tar.gz: 5d5105e8b37569182f1cf81c990567855988d3b5
 SHA512:
-  metadata.gz: 148fc8e46a965e6a0a95739639a2677a074c135395072ec04e802afdbf95fd46070e8572dab215d09f28b534e520b62e6bfe3f8bd3651555c881802ffb7937a0
-  data.tar.gz: c852fbcaba33c6520e5ab36ff089ce298e960e51a818d19f55465f765b68396dd3e25613b594f1bef5a11008323a97fd8387cb21c32320a46243c272ffedfd21
+  metadata.gz: b59af9ea9b654f0b4e3c51d39ef57c2efafa9b189514d913b56a0a891265dd5879839af271c40428c7aeaf4e3a7256d10f23ba368c0c3f0a2b55c521d16bff40
+  data.tar.gz: 38374403aae22507a19e6a572f7bb337d0bee6046566bcbec0990dd404c12a7adfc3517090ddba8d73a939bc226e97c9492c1684f77d9cba3668aa6e3a0c697f

data/README.md

@@ -1,7 +1,8 @@
 # EmapicConsul
 
-Put your Ruby code in the file `lib/emapic_consul`. To experiment with that code, run `bin/console` for an interactive prompt.
+This gem was developed during the [Jornadas de Inteligencia Colectiva para la Democracia](http://medialab-prado.es/article/madrid-inteligencia-colectiva-para-la-democracia).
 
+This gem was used in the [project](http://medialab-prado.es/article/inteligencia-colectiva-para-la-democracia-proyectos-seleccionados) which developed the [consul](https://github.com/consul/consul) + [emapic](https://github.com/Emapic) integration to provide consul with new functionalities such as proposal and votes geolocation.
 
 ## Installation
 
@@ -30,16 +31,18 @@ you are in *macOS*). An example setup might look like the following:
 
 ```bash
 # ~/.bash_profile
-export EMAPIC_HOST="192.168.1.199"
-export EMAPIC_PORT="3000"
-export EMAPIC_LOGIN="amiedes2"
-export EMAPIC_KEY="12"
-export EMAPIC_SECRET="12"
+export EMAPIC_HOST="192.168.1.199:80"
+export EMAPIC_LOGIN="example_login"
+export EMAPIC_KEY="example_key"
+export EMAPIC_SECRET="example_secret"
 ```
 
 ## Usage
 
-To register proposal creation in Emapic:
+To register proposal creation inside Emapic you need to follow the consul customization
+[guide](https://github.com/consul/consul/blob/master/CUSTOMIZE_ES.md) to modify
+existing models. You'll need to create a custom `Proposal` model with the following
+code:
 
 ```ruby
 # /app/models/custom/proposal.rb
@@ -54,6 +57,15 @@ class Proposal < ActiveRecord::Base
 end
 ```
 
+The approach to register proposal votes in Emapic is totally different since
+the `Vote` class is not directly instantiated by consul but it's done inside the
+`ActsAsVotable::Vote` clas of the [`acts_as_votable`](https://github.com/ryanto/acts_as_votable)
+gem.
+
+Probably the best way to handle this is to *monkey-patch* this class during the
+rails boot, but I wasn't able to do this with my current knowledge of rails, so
+I opted for a different approach.
+
 To register proposal voting in Emapic you need to modify the original
 `Proposal.register_vote` method, adding the following line:
 
@@ -61,30 +73,32 @@ To register proposal voting in Emapic you need to modify the original
 EmapicConsul::Api.vote_location_group(user, self)
 ```
 
-So it ends looking like this:
+So its code ends up looking like this:
 
 ```ruby
 # /app/models/proposal.rb
 class Proposal
-  def register_vote(user, vote_value)
+  def register_vote(user, vote_value, lat, lng)
     if votable_by?(user) && !archived?
       vote_by(voter: user, vote: vote_value)
-      EmapicConsul::Api.vote_location_group(user, self)
+      EmapicConsul::Api.vote_location_group(self, nil, lat, lng) unless (lat.nil? || lng.nil?)
     end
   end
 end
 ```
 
-## Development
+Modify the `ProposalsController.vote` method so it looks like the following:
 
-After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` 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).
+```ruby
+def vote
+    @proposal.register_vote(current_user, 'yes', params[:lat], params[:lng])
+    set_proposal_votes(@proposal)
+  end
+```
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/emapic_consul.
-
+Bug reports and pull requests are welcome on GitHub at https://github.com/amiedes/emapic_consul.
 
 ## License
 

data/lib/emapic_consul/api.rb

@@ -26,34 +26,34 @@ module EmapicConsul
       print_debug_end(response.code)
     end
 
-    # vote_location_group(usre_instance, proposal_instance)
-    def self.vote_location_group(voter, group)
-      print_debug_start("to notify vote creation")
+    # vote_location_group(proposal_instance, latitude, longitude)
+    def self.vote_location_group(group, latitude, longitude)
+      print_debug_start("to notify vote creation with lat/lng")
 
       request = build_generic_request("/api/locationgroup/#{emapic_login}/proposal_#{group.id}")
-      request.params = { user_id: voter.id, address: get_random_address }
+      request.params = { user_id: nil, lat: latitude, lng: longitude }
       response = request.send
 
       puts "Response body: #{response.body}"
       print_debug_end(response.code)
     end
 
-    def self.get_random_address
-      print_debug_start("to get the address")
-
-      uri = EmapicConsul::Request.build_uri(api_host, '/api/randomMadrid', api_port)
-      # The build_http_object is not meant to be called from this class. But when
-      # the get_random_address method disappears this call will be deleted
-      http = EmapicConsul::Request.build_http_object(uri)
-      request = Net::HTTP::Get.new(uri)
-
-      response = http.request(request)
-
-      puts "Address: #{JSON.parse(response.body)['display_name']}"
-      print_debug_end(response.code)
-
-      return JSON.parse(response.body)['display_name']
-    end
+    # def self.get_random_address
+    #   print_debug_start("to get the address")
+    #
+    #   uri = EmapicConsul::Request.build_uri(api_host, '/api/randomMadrid', api_port)
+    #   # The build_http_object is not meant to be called from this class. But when
+    #   # the get_random_address method disappears this call will be deleted
+    #   http = EmapicConsul::Request.build_http_object(uri)
+    #   request = Net::HTTP::Get.new(uri)
+    #
+    #   response = http.request(request)
+    #
+    #   puts "Address: #{JSON.parse(response.body)['display_name']}"
+    #   print_debug_end(response.code)
+    #
+    #   return JSON.parse(response.body)['display_name']
+    # end
 
     # def self.register_random_location(group_id, user_id)
     #   print_debug_start("to register a vote with a random address")
@@ -82,11 +82,12 @@ module EmapicConsul
       end
 
       def self.api_host
-        ENV['EMAPIC_HOST']
+        ENV['EMAPIC_HOST'].split(':')[0]
       end
 
       def self.api_port
-        ENV['EMAPIC_PORT']
+        port = ENV['EMAPIC_HOST'].split(':')[1]
+        (port.nil? 80 : port)
       end
 
       def self.emapic_login

data/lib/emapic_consul/version.rb

@@ -1,3 +1,3 @@
 module EmapicConsul
-  VERSION = "0.1.5.4"
+  VERSION = "0.1.5.5"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: emapic_consul
 version: !ruby/object:Gem::Version
-  version: 0.1.5.4
+  version: 0.1.5.5
 platform: ruby
 authors:
 - Alberto Miedes Garcés
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-12-01 00:00:00.000000000 Z
+date: 2016-12-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler