Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/johnvuko/jt-rails-address
Postal addresses management in Ruby On Rails and Javascript
https://github.com/johnvuko/jt-rails-address
address rails ruby
Last synced: about 2 months ago
JSON representation
Postal addresses management in Ruby On Rails and Javascript
- Host: GitHub
- URL: https://github.com/johnvuko/jt-rails-address
- Owner: johnvuko
- License: mit
- Created: 2015-07-26T17:47:56.000Z (over 9 years ago)
- Default Branch: master
- Last Pushed: 2016-09-20T09:17:49.000Z (over 8 years ago)
- Last Synced: 2024-10-12T05:55:01.330Z (3 months ago)
- Topics: address, rails, ruby
- Language: Ruby
- Homepage:
- Size: 10.7 KB
- Stars: 42
- Watchers: 5
- Forks: 4
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# JTRailsAddress
[](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
# Each field will be prefixed by 'address_'
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 the 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
There are also `add_address` and `remove_address` methods for migrations.
In your model:
```ruby
class User < ActiveRecord::Base
# Add a virtual field named `address` and a class method `address_fields` returning `JT::Rails::Address.fields` prefixed by `address_` in this case
has_address :address
end
```
### Javascript usage with Google Maps API
You probably want to use an autocompletion service like Google Maps API.
In your HTML:
```html
<%= form_for @user do |f| %>
<%= 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 %>
<%= f.check_box :address_destroy %>
<%= f.submit %>
<% end %>
```
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();
// Advanced usage with google options
$('.jt-address-autocomplete').jt_address({
type: ['restaurant'],
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(event, 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)
# Use the set a nil all address fields
my_instance.reset_address(:address)
# Use the set a nil all address fields with HTML forms
my_instance.update({address_destroy: true})
```
## 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.