rails_admin_place_field 0.0.8

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 8f43dc0c284e2982ee9d6a4ad25f28f543af39d9
+  data.tar.gz: 19b3dc88b7bf3473cf9178af8012f89b245b4ed6
+SHA512:
+  metadata.gz: 352c1570bbf58f106b6b5d72125e57e3612df581f3b696758e101ac7899f7d3f29f5a2a3f1ffb4c4045bc4b1df8e67561be6d7548bb34e4109f2515ae4f285a0
+  data.tar.gz: 0e00a819ac8395d726f672cbf2faf67db92d12bf639b8686b33caf299168e1f144a18a3ed9dbd3e0b5de32555b6f006eefdd3a19c260fc9e8fe19b509c0db53d

data/README.md

@@ -0,0 +1,65 @@
+# Rails Admin Place Field
+
+rails_admin_place_field is a gem that works with [rails_admin](https://github.com/sferik/rails_admin) to provide an easy to use Google Maps interface for displaying and setting geographic co-ordinates in a model and then performing lookups for associations to a nearby Google Place or Foursquare Venue
+
+Where a latitude and longitude is set on the model, it is indicated by a marker shown on a Google map centered at the marker. The administrator can change the value of these fields by clicking on the desired new location on the map.
+
+
+## Usage
+
+rails_admin_place_field expects that the model will have two attributes, one for latitude and one for longitude of the point represented. To enable rails_admin_place_field, add the following to your `Gemfile`:
+
+```ruby
+gem "rails_admin_place_field", :git => "git://github.com/thinkclay/rails_admin_place_field.git"
+```
+
+Then, add in your `config/initializers/rails_admin.rb` initializer:
+
+```ruby
+RailsAdmin.config do |config|
+  config.model Place do
+    edit do
+      field :latitude, :place
+      field :longitude, :hidden
+    end
+  end
+end
+```
+
+**Note**: The field which is set as a :place field must be the latitude field, not the longitude.
+
+
+## Configuration
+
+For different configurations, rails_admin_place_field can be configured with the following:
+
+- `longitude_field` - the name of the longitude field that forms the the co-ordinate with the latitude field specified. Defaults to "longitude"
+- `google_api_key` - if you use a Google Maps API Key, it can be specified here, otherwise the maps will do limited lookups without a key
+- `foursquare_api_key` - this api will be disabled until a valid key is provided
+- `places_api_key` - this api will be disabled until a valid key is provided
+- `default_latitude` - the latitude to center the map shown on if the latitude field is blank. Defaults to 51.5, the latitude of London, UK.
+- `default_longitude` - the longitude used if the longitude field is blank. Defaults to -0.126, the longitude of London, UK.
+
+A more complicated configuration example:
+
+```ruby
+RailsAdmin.config do |config|
+  config.model Place do
+    edit do
+      field :latitude, :place do
+        longitude_field :longitude
+        google_api_key "a1b2c3d4e5f6deadbeef"
+        places_api_key "a1b2c3d4e5f6deadbeef"
+        foursquare_api_key "a1b2c3d4e5f6deadbeef"
+        default_latitude -34.0
+        default_longitude 151.0
+      end
+    end
+  end
+end
+```
+
+-------
+rails_admin_place_field is licensed under the MIT license.
+
+Kudos and credit to [beyondthestory](https://github.com/beyondthestory/rails_admin_map_field) for his map_field which gave me the starting point to learn how to make this field

data/app/views/rails_admin/main/_place_select.html.haml

@@ -0,0 +1,88 @@
+= javascript_include_tag ("//maps.googleapis.com/maps/api/js?key=#{field.google_api_key}&sensor=false&callback=init_map_field")
+
+= javascript_tag do
+  :plain
+    function init_map_field()
+    {
+    jQuery(function() {
+      var marker = null;
+      var latlng = new google.maps.LatLng(
+        #{form.object.send(field.name) || field.default_latitude},
+        #{form.object.send(field.longitude_field) || field.default_longitude}
+      );
+
+      var myOptions = {
+        zoom: #{field.default_zoom_level},
+        center: latlng,
+        mapTypeId: google.maps.MapTypeId.ROADMAP
+      };
+
+      var map = new google.maps.Map(document.getElementById("#{field.dom_name}"), myOptions);
+
+  - if form.object.send(field.name) && form.object.send(field.longitude_field)
+    :plain
+      marker = new google.maps.Marker({
+        position: new google.maps.LatLng(#{form.object.send(field.name)},#{form.object.send(field.longitude_field)}),
+        map: map
+      });
+
+  :plain
+      google.maps.event.addListener(map, 'click', function(e) {
+        map_update(e.latLng);
+        foursquare_search(e.latLng.lat() + ',' + e.latLng.lng());
+      });
+
+      function map_update(location)
+      {
+        if (marker)
+        {
+          marker.setPosition(location);
+        }
+        else
+        {
+          marker = new google.maps.Marker({
+            position: location,
+            map: map
+          });
+        }
+
+        map.setCenter(location);
+        jQuery("##{field.latitude_dom_name}").val(location.lat());
+        jQuery("##{field.longitude_dom_name}").val(location.lng());
+      }
+
+      function foursquare_search(location)
+      {
+        var foursquare_url = 'https://api.foursquare.com/v2/venues/search?ll='+ location + '&intent=checkin'
+          + '&client_id=' + "#{field.foursquare_api_key}"
+          + '&client_secret=' + "#{field.foursquare_api_secret}"
+          + '&v=' + "#{Time.new.strftime("%Y%m%d")}";
+
+        $.get(
+          foursquare_url,
+          function(response) {
+            if ( response && response.meta.code == 200 )
+            {
+              response.response.venues.forEach(function(venue) {
+                jQuery('#foursquare_venue').append('<option value="'+venue.id+'">'+venue.name+'</option>').change(function() {
+                  jQuery("##{field.foursquare_dom_name}").val($(this).val());
+                });
+              });
+            }
+            else
+            {
+              alert('foursquare venue lookup failed');
+            }
+          });
+      }
+
+    })};
+
+
+%div.ramf-map-container{:id => field.dom_name, :style => "width:300px;height:200px"}
+%select#foursquare_venue
+  %option
+
+= form.send :hidden_field, field.foursquare_field, :id => field.foursquare_dom_name
+= form.send :hidden_field, field.name, :id => field.latitude_dom_name
+= form.send :hidden_field, field.longitude_field, :id => field.longitude_dom_name

data/lib/rails_admin_place_field/engine.rb

@@ -0,0 +1,7 @@
+require 'rails'
+require 'rails_admin_place_field'
+
+module RailsAdminPlaceField
+  class Engine < Rails::Engine
+  end
+end

data/lib/rails_admin_place_field/rails_admin/config/fields/types/place.rb

@@ -0,0 +1,72 @@
+module RailsAdmin::Config::Fields::Types
+  class Place < RailsAdmin::Config::Fields::Base
+
+    RailsAdmin::Config::Fields::Types::register(:place, self)
+
+    def allowed_methods
+      [@name, longitude_field, foursquare_field]
+    end
+
+    # THe name of the corresponding longitude field to match the latitude field
+    # in this object.
+    register_instance_option(:longitude_field) do
+      :longitude
+    end
+
+    register_instance_option(:foursquare_field) do
+      :foursquare
+    end
+
+    register_instance_option(:partial) do
+      :place_select
+    end
+
+    register_instance_option(:google_api_key) do
+      nil
+    end
+
+    register_instance_option(:places_api_key) do
+      nil
+    end
+
+    register_instance_option(:foursquare_api_key) do
+      nil
+    end
+
+    register_instance_option(:foursquare_api_secret) do
+      nil
+    end
+
+    # Latitude value to display in the map if the latitude attribute is nil
+    # (Otherwise the location defaults to (0,0) which is in the Gulf of Guinea
+    register_instance_option(:default_latitude) do
+      51.5 # Latitude of London, United Kingdom
+    end
+
+    # Longitude value to display if the longitude attribute is nil
+    register_instance_option(:default_longitude) do
+      -0.126 # Longitude of London, United Kingdom
+    end
+
+    # Default zoom level of the map
+    register_instance_option(:default_zoom_level) do
+      8
+    end
+
+    def dom_name
+      @dom_name ||= "#{bindings[:form].object_name}_#{@name}_#{longitude_field}"
+    end
+
+    def latitude_dom_name
+      @lat_dom_name ||= "#{bindings[:form].object_name}_#{@name}"
+    end
+
+    def longitude_dom_name
+      @lon_dom_name ||= "#{bindings[:form].object_name}_#{longitude_field}"
+    end
+
+    def foursquare_dom_name
+      @foursquare_dom_name ||= "#{bindings[:form].object_name}_#{foursquare_field}"
+    end
+  end
+end

data/lib/rails_admin_place_field.rb

@@ -0,0 +1,3 @@
+require 'rails_admin'
+require 'rails_admin_place_field/rails_admin/config/fields/types/place'
+load 'rails_admin_place_field/engine.rb'

metadata

@@ -0,0 +1,92 @@
+--- !ruby/object:Gem::Specification
+name: rails_admin_place_field
+version: !ruby/object:Gem::Version
+  version: 0.0.8
+platform: ruby
+authors:
+- Clay McIlrath
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-09-26 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rspec-rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '2.4'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '2.4'
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+- !ruby/object:Gem::Dependency
+  name: rails_admin
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>'
+      - !ruby/object:Gem::Version
+        version: 0.0.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>'
+      - !ruby/object:Gem::Version
+        version: 0.0.1
+description: A place field for RailsAdmin that can be used to retrieve a google place
+  or foursquare venue
+email:
+- clay.mcilrath@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/rails_admin_place_field/engine.rb
+- lib/rails_admin_place_field/rails_admin/config/fields/types/place.rb
+- lib/rails_admin_place_field.rb
+- app/views/rails_admin/main/_place_select.html.haml
+- README.md
+homepage: http://github.com/thinkclay/
+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: 1.3.6
+requirements: []
+rubyforge_project: rails_admin_place_field
+rubygems_version: 2.0.3
+signing_key: 
+specification_version: 4
+summary: Adds a place field to rails_admin using the Google Places and Foursquare
+  API's
+test_files: []