jt-rails-address 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 5e7d7fb2db68c3f3e8695fd5a95522fc86f73316
+  data.tar.gz: 7041289c7bf68a1521b18b8469222fc49ca563cf
+SHA512:
+  metadata.gz: a09f08c4ff694d0f80433916db56fb832fdfcedf0e7254d1166522f6db4f6776a883879c7dc94b70df31b5b92f61e79490dd4e540e475cdca8caad3869a0c4c0
+  data.tar.gz: e3b03d1954832b3180a25ec1036148c8f313e30924c3f8e2d0ce26d92cb8cfbe75b1f05ba61126891d46b4b403770a3067b61614f4b48fe5fc2c48b7c9102b82

data/.gitignore

@@ -0,0 +1,2 @@
+*.gem
+.DS_Store

data/Gemfile

@@ -0,0 +1,3 @@
+source 'https://rubygems.org'
+
+gemspec

data/LICENSE

@@ -0,0 +1,19 @@
+Copyright (c) 2015 Jonathan Tribouharet
+
+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,141 @@
+# JTRailsAddress
+
+[![Gem Version](https://badge.fury.io/rb/jt-rails-address.svg)](http://badge.fury.io/rb/jt-rails-address)
+
+JTRailsAddress simplify postal addresses management and geocoding with Google Maps API in Ruby On Rails and Javascript.
+
+## Installation
+
+JTRailsAddress is distributed as a gem, which is how it should be used in your app.
+
+Include the gem in your Gemfile:
+
+    gem 'jt-rails-address', '~> 1.0'
+
+## Usage
+
+### Basic usage
+
+In your migration file:
+
+```ruby
+class CreateUsers < ActiveRecord::Migration
+	def change
+		create_table :users do |t|
+
+			t.string :username, null: false
+			t.string :email, null: false
+			t.string :password_digest
+
+			t.address :address
+
+			t.timestamps null: false
+		end
+	end
+end
+```
+
+It will create all the fields you need for address management:
+
+- `formatted_address`, "Empire State Building, 350 5th Ave, New York, NY 10118"
+- `street_number`, "350"
+- `street_name`, "5th Ave"
+- `street`, "350 5th Ave", it's a concatenation of `street_number` and `street_name`
+- `city`
+- `zip_code`
+- `department`
+- `department_code`
+- `state`
+- `state_code`
+- `country`
+- `country_code`
+- `lat`, GPS latitude
+- `lng`, GPS longitude
+
+In your model:
+```ruby
+class User < ActiveRecord::Base
+
+    has_address :address
+
+end
+```
+
+It will only add a virtual field named `address`.
+
+### Javascript usage with Google Maps API
+
+You probably want to use an autocompletion service like Google Maps API.
+
+In your HTML:
+```html
+<!-- Basic form, address is just a virtual field used for searching the address on Google Maps API -->
+<%= form_for @user do |f| %>
+
+	<div class="jt-address-autocomplete">
+		<%= f.text_field :address, class: 'jt-address-search' %>
+
+		<% for attr in JT::Rails::Address.fields %>
+			<%= f.hidden_field "address_#{attr}", class: "jt-address-field-#{attr}" %>
+		<% end %>
+	</div>
+
+	<%= f.submit %>
+
+<% end %>
+
+<!-- Load Google Maps -->
+<script async type="text/javascript" src="//maps.googleapis.com/maps/api/js?libraries=places&callback=googleMapInitialize"></script>
+```
+
+In your `applicaton.js` you have to add:
+```javascript
+//= require jt_address
+
+// This function is call when Google Maps is loaded
+window.googleMapInitialize = function(){
+
+    // Simple usage
+    $('.jt-address-autocomplete').jt_address();
+    
+    // Advacned usage
+    $('.jt-address-autocomplete').jt_address({
+        types: ['geocode'],
+        componentRestrictions: { country: 'fr' }
+    });
+
+};
+```
+
+Each time the data for the address change, an event `jt:address:data_changed` is triggered.
+You can catch it with:
+
+```javascript
+$('.jt-address-autocomplete').on('jt:address:data_changed', function(data){
+	console.log(data);
+});
+
+```
+
+### Google Maps API in Ruby
+
+Thanks to [graticule](https://github.com/collectiveidea/graticule), there is a simple way to use autocomplete in Ruby.
+
+```ruby
+# Simple usage
+data = JT::Rails::Address.search("Eiffel Tower", "YOUR GOOGLE API KEY")
+
+# Advanced usage
+data = JT::Rails::Address.search("Eiffel Tower", "YOUR GOOGLE API KEY", {components: 'country:fr'})
+
+# Use the data retrieve from Google Maps API
+my_instance.load_address(:address, data)
+```
+
+## Author
+
+- [Jonathan Tribouharet](https://github.com/jonathantribouharet) ([@johntribouharet](https://twitter.com/johntribouharet))
+
+## License
+
+JTRailsAddress is released under the MIT license. See the LICENSE file for more info.

data/jt-rails-address.gemspec

@@ -0,0 +1,15 @@
+Gem::Specification.new do |s|
+	s.name = 'jt-rails-address'
+	s.summary = "Postal addresses management in Ruby On Rails and Javascript"
+	s.description = "JTRailsAddress simplify postal addresses management and geocoding with Google Maps in Ruby On Rails and Javascript."
+	s.homepage = 'https://github.com/jonathantribouharet/jt-rails-address'
+	s.version = '1.0.0'
+	s.files = `git ls-files`.split("\n")
+	s.require_paths = ['lib']
+	s.authors = ['Jonathan TRIBOUHARET']
+	s.email = 'jonathan.tribouharet@gmail.com'
+	s.license = 'MIT'
+	s.platform = Gem::Platform::RUBY
+
+	s.add_dependency('graticule', '> 2.0')
+end

data/lib/jt-rails-address.rb

@@ -0,0 +1,93 @@
+module JT
+	module Rails
+		module Address
+		end
+	end
+end
+
+require 'graticule'
+require 'schema'
+require 'validators'
+
+module JT::Rails::Address
+
+	module Rails
+		class Engine < ::Rails::Engine
+			# Get rails to add app, lib, vendor to load path
+		end
+	end
+
+	class Railtie < ::Rails::Railtie
+		initializer 'jt_rails_addresses.insert_into_active_record' do |app|
+			ActiveSupport.on_load :active_record do
+				ActiveRecord::ConnectionAdapters::Table.send :include, JT::Rails::Address::Schema::TableDefinition
+				ActiveRecord::ConnectionAdapters::TableDefinition.send :include, JT::Rails::Address::Schema::TableDefinition
+				ActiveRecord::ConnectionAdapters::AbstractAdapter.send :include, JT::Rails::Address::Schema::Statements
+
+				ActiveRecord::Base.send :include, JT::Rails::Address::Validators
+			end
+		end
+	end
+
+	def self.fields
+		JT::Rails::Address::Schema::COLUMNS.keys
+	end
+
+	def self.search(text, google_api_key, options = {})
+		geocoder = Graticule.service(:google).new(google_api_key)
+
+		begin
+			request_params = options.merge({ address: text })
+			response = geocoder.send('make_url', request_params).open('User-Agent' => Graticule::Geocoder::Base::USER_AGENT).read
+			json = JSON.parse(response)
+
+			return nil if !json['results'] || json['results'].size == 0
+
+			place = json['results'][0]
+
+			data = {}
+			data['lat'] = place['geometry']['location']['lat']
+			data['lng'] = place['geometry']['location']['lng']
+
+			data['formatted_address'] = place['formatted_address']
+
+			for address_component in place['address_components']
+
+				if address_component['types'][0] == 'street_number'
+					data['street_number'] = address_component['long_name']
+				elsif address_component['types'][0] == 'route'
+					data['street_name'] = address_component['long_name']
+				elsif address_component['types'][0] == 'country'
+					data['country'] = address_component['long_name']
+					data['country_code'] = address_component['short_name']
+				elsif address_component['types'][0] == 'administrative_area_level_1'
+					data['state'] = address_component['long_name']
+					data['state_code'] = address_component['short_name']
+				elsif address_component['types'][0] == 'administrative_area_level_2'
+					data['department'] = address_component['long_name']
+					data['department_code'] = address_component['short_name']
+				elsif address_component['types'][0] == 'locality' || address_component['types'][0] == 'administrative_area3'
+					data['city'] = address_component['long_name']
+				elsif address_component['types'][0] == 'postal_code'
+					data['zip_code'] = address_component['long_name']
+				end
+
+			end
+
+		   if !data['street_name'].blank?
+                if !data['street_number'].blank?
+                    data['street'] = "#{data['street_number']} #{data['street_name']}"
+                else
+                    data['street'] = data['street_name']
+                end
+            end
+
+			return data
+		rescue Exception => e
+			STDERR.puts e.message
+		end
+
+		return nil
+	end
+
+end

data/lib/schema.rb

@@ -0,0 +1,54 @@
+module JT::Rails::Address::Schema
+
+	COLUMNS = {
+		formatted_address: :string,
+		street_number: :string,
+		street_name: :string,
+		street: :string,
+		city: :string,
+		zip_code: :string,
+		department: :string,
+		department_code: :string,
+		state: :string,
+		state_code: :string,
+		country: :string,
+		country_code: :string,
+		lat: :float,
+		lng: :float,
+	}
+
+	module Statements
+		def add_address(table_name, *arguments)
+			raise ArgumentError, "Please specify name in your add_address call in your migration." if arguments.empty?
+
+			arguments.each do |prefix|
+				COLUMNS.each_pair do |column_name, column_type|
+					add_column(table_name, "#{prefix}_#{column_name}", column_type)
+				end
+			end
+		end
+
+		def remove_address(table_name, *arguments)
+			raise ArgumentError, "Please specify name in your remove_address call in your migration." if arguments.empty?
+
+			arguments.each do |prefix|
+				COLUMNS.each_pair do |column_name, column_type|
+					remove_column(table_name, "#{prefix}_#{column_name}", column_type)
+				end
+			end
+		end
+	end
+
+	module TableDefinition
+		def address(*arguments)
+			raise ArgumentError, "Please specify name in your address call in your migration." if arguments.empty?
+
+			arguments.each do |prefix|
+				COLUMNS.each_pair do |column_name, column_type|
+					column("#{prefix}_#{column_name}", column_type)
+				end
+			end
+		end
+	end
+
+end

data/lib/validators.rb

@@ -0,0 +1,23 @@
+module JT::Rails::Address::Validators
+	
+	extend ActiveSupport::Concern
+
+	class_methods do
+
+		def has_address(prefix, options = {})
+			attr_accessor prefix
+		end
+
+	end
+
+	def load_address(prefix, data)
+		for field in JT::Rails::Address.fields
+			self["#{prefix}_#{field}"] = nil
+		end
+
+		for key, value in data
+			self["#{prefix}_#{key}"] = value
+		end
+	end
+
+end

data/vendor/assets/javascripts/jt_address.js

@@ -0,0 +1,106 @@
+;(function($){
+
+    $.fn.jt_address = function(options) {
+
+        return this.each(function() {
+            setupInput($(this), options);
+        });
+
+        function setupInput($container, options){
+            var $input = $container.find('input[type="text"].jt-address-search').first();
+            if($input.length == 0){
+                $input = $container.find('input[type="text"]').first();
+            }
+            
+            $input.on('input', function(){
+                inputChanged($container);
+            });
+
+            $input.on('change', function(){
+                inputChanged($container);
+            });
+
+            var autocomplete = new google.maps.places.Autocomplete($input[0], options);
+
+            google.maps.event.addListener(autocomplete, 'place_changed', function(){
+                var place = autocomplete.getPlace();
+                var data = {};
+
+                if(!place.geometry){
+                    dataChanged($container, {});
+                    return;
+                }
+
+                data['lat'] = place.geometry.location.lat();
+                data['lng'] = place.geometry.location.lng();
+
+                data['formatted_address'] = place['formatted_address'];
+
+                for(var i = 0; i < place.address_components.length; ++i){
+                   if(place.address_components[i].types[0] == 'street_number'){
+                        data['street_number'] = place.address_components[i].long_name;
+                    }
+                    else if(place.address_components[i].types[0] == 'route'){
+                        data['street_name'] = place.address_components[i].long_name;
+                    }
+                    else if(place.address_components[i].types[0] == 'country'){
+                        data['country'] = place.address_components[i].long_name;
+                        data['country_code'] = place.address_components[i].short_name;
+                    }
+                    else if(place.address_components[i].types[0] == 'administrative_area_level_1'){
+                        data['state'] = place.address_components[i].long_name;
+                        data['state_code'] = place.address_components[i].short_name;
+                    }
+                    else if(place.address_components[i].types[0] == 'administrative_area_level_2'){
+                        data['department'] = place.address_components[i].long_name;
+                        data['department_code'] = place.address_components[i].short_name;
+                    }
+                    else if(place.address_components[i].types[0] == 'locality' ||
+                        place.address_components[i].types[0] == 'administrative_area3'){
+                        data['city'] = place.address_components[i].long_name;
+                    }
+                   else if(place.address_components[i].types[0] == 'postal_code'){
+                        data['zip_code'] = place.address_components[i].long_name;
+                    }
+                }
+
+                if(data['street_name']){
+                    if(data['street_number']){
+                        data['street'] = data['street_number'] + ' ' + data['street_name'];
+                    }
+                    else{
+                        data['street'] = data['street_name'];
+                    }
+                }
+
+                dataChanged($container, data);
+            });
+        }
+
+        // Reset values if input value is reset
+        function inputChanged($container){
+            var $input = $container.find('input[type="text"]');
+
+            if($input.val().length == 0){
+                dataChanged($container, {});
+            }
+        }
+
+        function dataChanged($container, data){
+            updateInputs($container, data);
+            $container.trigger('jt:address:data_changed', data);
+        }
+
+         function updateInputs($container, data){
+            // Reset all fields
+            $container.find('[class*="jt-address-field"]').val('');
+
+            for(var attr in data){
+                var value = data[attr];
+                $container.find('.jt-address-field-' + attr).val(value);
+            }
+        }
+
+    }
+
+})(jQuery);

metadata

@@ -0,0 +1,67 @@
+--- !ruby/object:Gem::Specification
+name: jt-rails-address
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Jonathan TRIBOUHARET
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-07-26 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: graticule
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>'
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>'
+      - !ruby/object:Gem::Version
+        version: '2.0'
+description: JTRailsAddress simplify postal addresses management and geocoding with
+  Google Maps in Ruby On Rails and Javascript.
+email: jonathan.tribouharet@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE
+- README.md
+- jt-rails-address.gemspec
+- lib/jt-rails-address.rb
+- lib/schema.rb
+- lib/validators.rb
+- vendor/assets/javascripts/jt_address.js
+homepage: https://github.com/jonathantribouharet/jt-rails-address
+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: []
+rubyforge_project: 
+rubygems_version: 2.0.14
+signing_key: 
+specification_version: 4
+summary: Postal addresses management in Ruby On Rails and Javascript
+test_files: []