nom-ruby 0.2.0

data/CHANGELOG.md

@@ -0,0 +1,12 @@
+###Changelog for nom-ruby
+
+####0.1.{ 0 - 20 } - Initial Dev Release
+- Author: Brian Norton
+- Support for basic Location Fetching, and User Management
+
+####0.2.0 - Initial Public Release
+- 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)
+

data/CONTRIBUTORS.md

@@ -0,0 +1 @@
+Brian Norton - [github (@bnorton)](http://github.com/bnorton) - [twitter (@nort)](http://twitter.com/nort)

data/Gemfile

@@ -0,0 +1,4 @@
+source :gemcutter
+
+# Dependencies are specified in nom-ruby.gemspec;
+gemspec

data/LICENSE.md

@@ -0,0 +1,19 @@
+Copyright (c) 2012 Nom [justnom.it](http://justnom.it)
+
+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,100 @@
+# nom-ruby
+    - The bindings for the Nom API in ruby
+
+### Examples of the headless API
+- https://justnom.it/locations/here.json?lat=37.7969398498535&lng=-122.399559020996
+- 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')
+
+## All Success Results Take the Form:
+    {
+      "status": 1,
+      "message": "OK",
+      "results": [
+        {"result": 1},
+        {"result": 2},
+        ...,
+        {"result": "n"}
+      ]
+    }
+
+## All Error Results Take the Form:
+    {
+      "status": -1,
+      "message": "Some display-ready message about what the error was",
+      "results": []
+    }
+
+## User:
+    {
+      name: "Brian Norton",
+      city: "San Francisco",
+      created_at: "2011-11-23T09:46:35Z",
+      image_url: "https://graph.facebook.com/679816146/picture?type=large",
+      updated_at: "2011-12-20T07:06:57Z",
+      url: "http://justnom.it/users/bn",
+      has_joined: true,
+      follower_count: 16,
+      user_nid: "4eccc0fbeef0a64dcf000001",
+      screen_name: "bn"
+    }
+   
+## Location:
+    {
+      name: "The Grove Cafe Yerba Buena",
+      location_nid: "4ec8b964eef0a679f80005be",
+      primary_category: "4ec8b8a7eef0a679f8000001",
+      secondary_category: "4ec8b8cdeef0a679f8000151",
+      cross_street: "Between 3rd St and Annie St",
+      address: "690 Mission St San Francisco, CA 94105-4014",
+      street: "690 Mission St",
+      city: "San Francisco",
+      state: "California"
+      woeid: "12797156",
+      rank_value: 38,
+      gowalla_url: null,
+      fsq_id: "4b7ef75cf964a520ee0c30e3",
+      created_at: "2011-11-20T08:25:08Z",
+      cost: "$$",
+      updated_at: "2011-12-08T17:13:23Z",
+      url: null,
+      timeofday: "lunch | dinner",
+      rank: "38/7821",
+      phone: "415-957-0558",
+      neighborhoods: "Financial District South",
+      yid: "45199920"
+    }
+   
+## Recommendation:
+    {
+      created_at: "2011-12-21T07:21:19Z",
+      location: @location,
+      title: null,
+      token: "7LVSG",
+      recommendation_nid: "4ef188efeef0a603e3000002",
+      text: "I just Nommed @ Velvet Room justnom.it/r/7LVSG",
+      user: @user,
+      image: {
+        size: "600x320#",
+        url: "http://static.justnom.it/8e637e6585609c9df21577afc2b333dabeeb32c6.medium.png",
+        image_nid: "4ee56d6beef0a61a7d000003"
+      },
+      lng: -122.41,
+      lat: 37.7892
+    }
+  
+## Thumb
+    {
+      user_nid: "4eccc137eef0a64dcf000002",
+      created_at: "2011-12-21T05:03:22Z",
+      location: @location,
+      value: 1
+    }

data/lib/nom-ruby/api.rb

@@ -0,0 +1,68 @@
+module Nom
+  class API
+    
+    def here(lat, lng, options = {})
+      start, limit = Nom::Util.page(options)
+      Nom::API.handle.get('/locations/here', {
+        :lat => lat,
+        :lng => lng,
+        :dist => (options[:dist] || 0.5),
+        :start => start,
+        :limit => limit
+      })
+    end
+
+    def location_search(query, options = {})
+      start, limit = Nom::Util.page(options)
+      params = { :query => query }
+
+      params.merge!({
+        :lat => options[:lat],
+        :lng => options[:lng]
+      }) if(options[:lat].present? && options[:lng].present?)
+
+      params.merge!({
+        :location => options[:location]
+      }) if options[:location].present?
+
+      Nom::API.handle.get('/locations/search', params)
+    end
+
+    def register(email, password, options ={})
+      Nom::API.handle.post('/users/register', {
+        :email => email,
+        :password => password,
+        :screen_name => options[:screen_name],
+        :name => options[:name],
+        :city => options[:city]
+      })
+    end
+
+    # Any item out of email, user_nid, screen_name will work
+    def login(password, options ={})
+      Nom::API.handle.post('/users/login', {
+        :password => password,
+        :email => options[:email],
+        :user_nid => options[:user_nid],
+        :screen_name => options[:screen_name]
+      })
+    end
+
+    def user_search(query, options = {})
+      start, limit = Nom::Util.page(options)
+      Nom::API.handle.get('/locations/search', {
+        :query => query, # If the input value is of unknown origin
+        :screen_name => options[:screen_name],
+        :email => options[:email]
+      })
+    end
+
+    private
+    
+    # keep this around for re-use
+    def self.handle
+      @handle ||= Nom::Fetcher.new # (:key => Nom::Keys.developer, :secret => Nom::Keys.secret)
+    end
+
+  end
+end

data/lib/nom-ruby/fetcher.rb

@@ -0,0 +1,55 @@
+module Nom
+  class Fetcher
+
+    def post(path, body = {})
+      url = url_for_path(path)
+      go(url, Net::HTTP::Post, body)
+    end
+
+    def get(path, params = {})
+      url = url_for_path(path)
+      add_params(url, params)
+      go(url, Net::HTTP::Get)
+    end
+
+    private
+
+    def port
+      443
+    end
+
+    def base_url
+      "https://justnom.it"
+    end
+
+    def start(url)
+      uri = URI.parse(url)
+      http = Net::HTTP.new(uri.host, uri.port)
+      http.use_ssl = true
+      http.verify_mode = OpenSSL::SSL::VERIFY_NONE
+      [http, uri]
+    end
+
+    def go(url, type, body=nil)
+      http,uri = start(url)
+      request = type.new(uri.request_uri)
+      request.set_form_data(body) if(body.kind_of?(Hash) && body.present?)
+      JSON.parse(http.request(request).body) rescue {}
+    end
+
+    # always request json
+    def url_for_path(path)
+      url = "#{base_url}#{path}"
+      url << '.json' unless url =~ /\.json$/
+    end
+
+    # if any params are present
+    def add_params(url, params)
+      return unless params.kind_of? Hash
+      extra = (url =~ /\?/) ? "&" : "?"
+      url << extra
+      url << params.to_param unless params.blank?
+    end
+
+  end
+end

data/lib/nom-ruby/keys.rb

@@ -0,0 +1,11 @@
+module Nom
+  class Keys
+    def self.developer
+      "42ga53s0_sample_developer_key_4etnom"
+    end
+
+    def self.secret
+      "42ga53s0_sample_secret_4etnom"
+    end
+  end
+end

data/lib/nom-ruby/util.rb

@@ -0,0 +1,10 @@
+module Nom
+  class Util
+    def self.page(options)
+      start = options[:start].present? ? options[:start] : 0
+      limit = options[:limit].present? ? options[:limit] : 15
+      start = 0 if start < 0
+      [start, limit]
+    end
+  end
+end

data/lib/nom-ruby/version.rb

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

data/lib/nom-ruby.rb

@@ -0,0 +1,11 @@
+require 'rubygems'
+require 'net/http'
+require 'net/https'
+require 'active_support'
+require 'json'
+
+require 'nom-ruby/fetcher'
+require 'nom-ruby/keys'
+require 'nom-ruby/util'
+
+require 'nom-ruby/api'

data/nom-ruby.gemspec

@@ -0,0 +1,30 @@
+# -*- encoding: utf-8 -*-
+require File.expand_path("../lib/nom-ruby/version", __FILE__)
+
+Gem::Specification.new do |s|
+  s.name        = "nom-ruby"
+  s.version     = GemNom::VERSION::STRING
+  s.platform    = Gem::Platform::RUBY
+  s.author     = 'Brian Norton'
+  s.email       = ["team@justnom.it"]
+  s.homepage    = "https://github.com/bnorton/nom-ruby"
+  s.summary     = "Nom API ruby client"
+  s.description = "Ruby client for using the Nom API. Nom is the best way to find out what's best in your world."
+  
+  s.required_rubygems_version = ">= 1.3.6"
+  s.rubyforge_project         = "nom-ruby"
+
+  s.add_dependency 'json', '>= 1.4.6'
+
+  s.add_development_dependency "bundler", ">= 1.0.0"
+  s.add_development_dependency "gemcutter", ">= 0.6.1"
+  s.add_development_dependency "rspec", "~> 2.2"
+
+  s.files = `git ls-files`.split("\n") - ['.rvmrc', '.gitignore']
+  s.test_files = `git ls-files`.split("\n").grep(/^spec/)
+  s.require_paths = %w[lib]
+
+  s.extra_rdoc_files = ['README.md', 'LICENSE.md', 'CHANGELOG.md']
+  s.rdoc_options = ['--line-numbers', '--inline-source', '--title', 'nom-ruby', '--main', 'README.md']
+
+end

metadata

@@ -0,0 +1,153 @@
+--- !ruby/object:Gem::Specification 
+name: nom-ruby
+version: !ruby/object:Gem::Version 
+  hash: 23
+  prerelease: 
+  segments: 
+  - 0
+  - 2
+  - 0
+  version: 0.2.0
+platform: ruby
+authors: 
+- Brian Norton
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-12-30 00:00:00 Z
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: json
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 11
+        segments: 
+        - 1
+        - 4
+        - 6
+        version: 1.4.6
+  type: :runtime
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: bundler
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 23
+        segments: 
+        - 1
+        - 0
+        - 0
+        version: 1.0.0
+  type: :development
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: gemcutter
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 5
+        segments: 
+        - 0
+        - 6
+        - 1
+        version: 0.6.1
+  type: :development
+  version_requirements: *id003
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  prerelease: false
+  requirement: &id004 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 7
+        segments: 
+        - 2
+        - 2
+        version: "2.2"
+  type: :development
+  version_requirements: *id004
+description: Ruby client for using the Nom API. Nom is the best way to find out what's best in your world.
+email: 
+- team@justnom.it
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- README.md
+- LICENSE.md
+- CHANGELOG.md
+files: 
+- CHANGELOG.md
+- CONTRIBUTORS.md
+- Gemfile
+- LICENSE.md
+- README.md
+- lib/nom-ruby.rb
+- lib/nom-ruby/api.rb
+- lib/nom-ruby/fetcher.rb
+- lib/nom-ruby/keys.rb
+- lib/nom-ruby/util.rb
+- lib/nom-ruby/version.rb
+- nom-ruby.gemspec
+- spec/location_spec.rb
+- spec/user_spec.rb
+- spec/util_spec.rb
+homepage: https://github.com/bnorton/nom-ruby
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --line-numbers
+- --inline-source
+- --title
+- nom-ruby
+- --main
+- README.md
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 23
+      segments: 
+      - 1
+      - 3
+      - 6
+      version: 1.3.6
+requirements: []
+
+rubyforge_project: nom-ruby
+rubygems_version: 1.8.11
+signing_key: 
+specification_version: 3
+summary: Nom API ruby client
+test_files: 
+- spec/location_spec.rb
+- spec/user_spec.rb
+- spec/util_spec.rb