nom-ruby 0.2.0 → 0.2.1

data/CHANGELOG.md

@@ -8,5 +8,7 @@
 - Author: Brian Norton
 - Locations { here, search}
 - Users { register, login, search }
-- Seen at [rubygems/nom-ruby]() and [github/nom-ruby](https://github.com/bnorton/nom-ruby)
+- Seen at [rubygems/nom-ruby](https://rubygems.org/gems/nom-ruby) and [github/nom-ruby](https://github.com/bnorton/nom-ruby)
 
+####0.2.1 - Bugfix
+- naming was off for an api method

data/README.md

@@ -6,13 +6,70 @@
 - https://justnom.it/activities.json?user_nid=4eccc0fbeef0a64dcf000001
 - https://justnom.it/locations/search.json?lng=-122.3898&lat=37.81273&query=king
 
-## Usage:
-    @api_handle = Nom::API.new(:key => "your developer key")
-    @user        = @api_handle.login('user_name or email', 'password')
-    @locations   = @api_handle.here(:lat => 33.3, :lng => -122.2)
-    @activities  = @api_handle.activities(:user_nid => '4eccc0fbeef0a64dcf000001')
-    @api_handle.recommend(:text => 'I Just Nommed at ...', :user_nid => '4eccc0fbeef0a64dcf000001', :auth_token => '2af...fad3y')
-    @api_handle.thumb(:location_nid => "4edgc0fbadf0a64dcf110037", :user_nid => '4eccc0fbeef0a64dcf000001', :auth_token => '2af...fad3y')
+###Getting Started
+#####Dependencies:
+- `json`
+- `net/http`
+
+#####Setup:
+- `gem install nom-ruby`
+- In an initializer `require 'nom-ruby'`
+- Then just make the new API handle with `handle = Nom::API.new`
+
+###Examples:
+
+####Location (here):
+    handle = Nom::API.new
+    locations = handle.here(37.7969, -122.39955)
+
+####Location (here - paginated to page 3):
+    handle = Nom::API.new
+    locations = handle.here(37.7969, -122.39955, {
+      :start => 30,
+      :limit => 15
+    })
+
+####Geolocation based search for 'vegetarian'
+    handle = Nom::API.new
+    locations = handle.location_search('vegetarian', {
+      :lat => 37.7969,
+      :lng => -122.39955
+    })
+
+
+####User search for 'team'
+    handle = Nom::API.new
+    users = handle.user_search('team')
+    users = handle.user_search('test_accout@justnom.it')
+
+####User registration (simple):
+    handle = Nom::API.new
+    user = handle.register('test_accout@justnom.it', 'a_password')
+
+####User registration (with options):
+    handle = Nom::API.new
+    user = handle.register('test_accout@justnom.it', 'a_password', {
+      :name => "The Nom Team",
+      :city => 'San Francisco',
+      :screen_name => 'team'
+    })
+
+####User Login (identifier and password based)
+    handle = Nom::API.new
+    user = handle.login('a_password', {:email => 'test_accout2@justnom.it'})
+    user = handle.login('a_password', {:user_nid => '4efd9128eef0a63881000001'}) ## same user a above
+
+####Yet Unimplemented
+    
+    #### Not yet implemented ####
+    # activities = handle.activities(:user_nid => '4eccc0fbeef0a64dcf000001')
+    # handle.recommend(:text => 'I Just Nommed at ...', :user_nid => '4eccc0fbeef0a64dcf000001', :auth_token => '2af...fad3y')
+    # handle.thumb(:location_nid => "4edgc0fbadf0a64dcf110037", :user_nid => '4eccc0fbeef0a64dcf000001', :auth_token => '2af...fad3y')
+    #############################
+
+
+###Key For Response types:
+- The `@` symbol is used to denote an entity unto itself. In the case of `@location` then in place you can logically expand a location object for `@location`. This is done for brevity.
 
 ## All Success Results Take the Form:
     {
@@ -42,7 +99,7 @@
       updated_at: "2011-12-20T07:06:57Z",
       url: "http://justnom.it/users/bn",
       has_joined: true,
-      follower_count: 16,
+      follower_count: 164,
       user_nid: "4eccc0fbeef0a64dcf000001",
       screen_name: "bn"
     }

data/lib/nom-ruby/api.rb

@@ -50,7 +50,7 @@ module Nom
 
     def user_search(query, options = {})
       start, limit = Nom::Util.page(options)
-      Nom::API.handle.get('/locations/search', {
+      Nom::API.handle.get('/users/search', {
         :query => query, # If the input value is of unknown origin
         :screen_name => options[:screen_name],
         :email => options[:email]

data/lib/nom-ruby/version.rb

@@ -2,7 +2,7 @@ module GemNom
   module VERSION
     MAJOR  = 0
     MINOR  = 2
-    PATCH  = 0
+    PATCH  = 1
     PRE    = nil
     STRING = [MAJOR, MINOR, PATCH, PRE].compact.join('.')
   end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: nom-ruby
 version: !ruby/object:Gem::Version 
-  hash: 23
+  hash: 21
   prerelease: 
   segments: 
   - 0
   - 2
-  - 0
-  version: 0.2.0
+  - 1
+  version: 0.2.1
 platform: ruby
 authors: 
 - Brian Norton