geo_contrast 0.0.1 → 0.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 381617d86fb5ddf5ceb5dfee09cf062ff804d4f1
-  data.tar.gz: 41e8f1994fefb73b5e536d69c49445a549ecac49
+  metadata.gz: 4683e82af6440462adac2486f460c25f66949f48
+  data.tar.gz: f13e132f69f6bc3862e807dd3c38456e253fed9b
 SHA512:
-  metadata.gz: 20f03db9381dbd6a2c35626af2514c41a51c2a6db36bf3708c56196ee7e9fe9dd8111c4713602157c29ba493763dff8a7c52212ed00be2e816097293e7e6cc61
-  data.tar.gz: c70f8ca7ad3fb52c90969f02fed2cd7dc976351d76c1757bed6a950405c9b52b4a5f1a7424b961dd1bed7e6a07733d13bb8c81e2e3549c10cf29b7935e6e6ae3
+  metadata.gz: f40da18cba0246c943c05fa147545991ce047c4466be2a496dbdb05c6a100e0494469243835a92ec82ed65254f60ace8c5299bbcb714b63c857f4f2d628c9d92
+  data.tar.gz: 014270e976bf346562481937f2778a6fce9133209ed1420946b6b18e701508667446e6b136d5ddc343f2586299b3ae0b84841ef7f916a918e9262583a52eeb0c

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2009-2014 CODELAND. http://codeland.com.br
+
+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

@@ -1,10 +1,12 @@
 # GeoContrast
-
-TODO: Write a gem description
+GeoContrast allows you to transform a simple text field in a Google Maps Autocomplete search field, bringing the name of streets, cities or an establishments.
 
 ## Installation
+Install it yourself as:
+
+    $ gem install geo_contrast
 
-Add this line to your application's Gemfile:
+Or add this line to your application's Gemfile:
 
 ```ruby
 gem 'geo_contrast'
@@ -14,17 +16,66 @@ And then execute:
 
     $ bundle
 
-Or install it yourself as:
+## Usage
+In `application.js` insert the following line:
 
-    $ gem install geo_contrast
+```javascript
+//= require geo_contrast
+```
 
-## Usage
+Inside `application.html.erb` call the Google Places Autocomplete:
 
-TODO: Write usage instructions here
+```erb
+<%= javascript_include_tag 'application', '//maps.googleapis.com/maps/api/js?libraries=places','data-turbolinks-track' => true %>
+```
 
-## Contributing
+Then, inside your form just add a class (or id) to your input field and inside `application.js` call the `GeoContrast` initialize function:
+
+```javascript
+$('.your_class').geoContrast();
+```
+
+## Customizing the results
+
+You have a few options to customize the return address from Google.
+You can specify the kind of search with this options:
 
-1. Fork it ( https://github.com/[my-github-username]/geo_contrast/fork )
+### Format
+With this it returns the short address. Eg. "San Francisco":
+```javascript
+$('.your_class').geoContrast({format: "short"});
+```
+This one returns the long version of the address. Eg. "San Francisco, California, United States of America":
+```javascript
+$('.your_class').geoContrast({format: "formatted"});
+```
+
+### Gmaps Options
+
+If you want to search just for cities, for example, you can pass a option to specify this:
+```javascript
+$('.your_class').geoContrast({format: "long", options_gmaps: {types: ['(cities)']}});
+```
+
+## ROADMAP
+
+Here is the next things that will be (probably) implemented:
+
+1. Better way to handle coordinate fields (latitude, longitude)
+2. Find a way to put Google Maps easily
+3. Easy integration with SimpleForm
+
+**...and more**
+
+The options are:
+
+1. 'geocode' -> For addresses.
+2. '(regions)' -> For administrative regions.
+3. 'establishment' -> For businesses.
+4. '(cities)' -> For just city names.
+
+## Contributing
+1. Fork it ( https://github.com/codelandev/geo-contrast/fork )
 2. Create your feature branch (`git checkout -b my-new-feature`)
 3. Commit your changes (`git commit -am 'Add some feature'`)
 4. Push to the branch (`git push origin my-new-feature`)

data/lib/geo_contrast/version.rb

@@ -1,3 +1,3 @@
 module GeoContrast
-  VERSION = "0.0.1"
+  VERSION = "0.0.3"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: geo_contrast
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.3
 platform: ruby
 authors:
 - CODELAND
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-12-16 00:00:00.000000000 Z
+date: 2014-12-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -52,7 +52,8 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-description: This description sucks and should be fixed
+description: GeoContrast allows you to transform a simple text field in a Google Maps
+  Autocomplete search field, bringing the name of streets, cities or an establishments.
 email:
 - contato@codeland.com.br
 executables: []
@@ -64,7 +65,7 @@ files:
 - lib/geo_contrast.rb
 - lib/geo_contrast/version.rb
 - vendor/assets/javascripts/geo_contrast.js
-homepage: https://github.com/codelandev/geocontrast
+homepage: https://github.com/codelandev/geo-contrast
 licenses:
 - MIT
 metadata: {}
@@ -87,5 +88,6 @@ rubyforge_project:
 rubygems_version: 2.2.2
 signing_key: 
 specification_version: 4
-summary: This summary sucks and should be fixed
+summary: GeoContrast allows you to transform a simple text field in a Google Maps
+  Autocomplete search field, bringing the name of streets, cities or an establishments.
 test_files: []