foursquare_rails_generators 0.1.1 → 0.1.2

data/.gitignore

@@ -0,0 +1 @@
+.DS_Store

data/README.md

@@ -0,0 +1,2 @@
+In 1 minute, get your Rails app with Foursquare running on Herolu
+==========

data/foursquare_rails_generators.gemspec

@@ -0,0 +1,12 @@
+Gem::Specification.new do |s|
+  s.name          = 'foursquare_rails_generators'
+  s.version       = '0.1.2'
+  s.date          = '2012-10-26'
+  s.summary       = "Foursquare Rails Generators"
+  s.description   = "Collection of Rails generators for the Foursquare API"
+  s.authors       = ["Pierre Valade"]
+  s.email         = 'pierre@foursquare.com'
+  s.files         = `git ls-files`.split("\n")
+  s.require_paths = ['lib']
+  s.homepage      = 'http://rubygems.org/gems/foursquare_rails_generators'
+end

data/lib/foursquare_rails_generators.rb

@@ -0,0 +1,4 @@
+require 'rails/generators'
+
+require File.expand_path('../generators/foursquare/authentication/authentication_generator', __FILE__)
+require File.expand_path('../generators/foursquare/push/push_generator', __FILE__)

data/lib/generators/foursquare/authentication/authentication_generator.rb

@@ -0,0 +1,61 @@
+module Foursquare
+	module Generators
+		class AuthenticationGenerator < Rails::Generators::Base
+			source_root File.expand_path("../templates", __FILE__)
+
+			desc "Adds Foursquare Connect to your app"
+			argument :settings, type: :hash, banner: "client_id:id client_secret:secret"
+
+			def validates_settings
+				raise "incorret params" if settings['client_id'].blank? || settings['client_secret'].blank?
+			end
+
+			def add_oauth2_gem
+				gem 'oauth2'
+			end
+
+			def create_foursquare_user_model
+				migration_template 'migrations/create_foursquare_user.rb'
+				template 'models/foursquare_user.rb', File.join('app/models/', 'foursquare_user.rb')
+			end
+
+			def create_foursquare_client_model
+				template 'models/foursquare_client.rb', File.join('app/models/', 'foursquare_client.rb')
+			end
+
+			def run_migrations
+				rake 'db:migrate'
+			end
+
+			def create_client_controller
+				template 'controllers/clients/foursquare_clients_controller.rb', File.join('app/controllers/clients', 'foursquare_clients_controller.rb')
+			end
+
+			def add_root_routes
+				route "root :to => 'users#new'"
+			end
+
+			def add_clients_routes
+				route(
+%Q{
+	scope module: 'clients' do
+		resources :foursquare_clients, only: ['new'], path: 'clients/foursquare' do
+		  collection do
+		    get 'callback'
+		  end
+		end
+	end
+}
+				)
+			end
+
+			def create_users_controller
+				template 'controllers/users_controller.rb', File.join('app/controllers/', 'users_controller.rb')
+			end
+
+			def add_user_routes
+				route "resource :user"
+			end
+		end
+	end
+end

data/lib/generators/foursquare/authentication/templates/controllers/clients/foursquare_clients_controller.rb

@@ -0,0 +1,24 @@
+class Clients::FoursquareClientsController < ApplicationController
+	def new
+		# https://developer.foursquare.com/overview/auth
+		options = {
+		  redirect_uri: callback_foursquare_clients_url,
+		}
+		redirect_to client.auth_code.authorize_url options
+	end
+
+	def callback
+		if params[:error]
+			# TODO: manage error
+		end
+		token = client.auth_code.get_token params[:code], redirect_uri: callback_foursquare_clients_url
+		user = FoursquareUser.find_or_create_by_access_token(token.token)
+		session[:user_id] = user.id
+		redirect_to user_path
+	end
+
+	private
+	def client
+	  FoursquareClient.oauth2_client
+	end
+end

data/lib/generators/foursquare/authentication/templates/controllers/users_controller.rb

@@ -0,0 +1,14 @@
+class UsersController < ApplicationController
+  def new
+    render text: "<a href='#{new_foursquare_client_path}'><img src='https://playfoursquare.s3.amazonaws.com/press/logo/connect-black.png' /></a>"
+  end
+
+  def show
+    render text: "hello #{current_user.name}"
+  end
+
+  private
+  def current_user
+    @current_user ||= FoursquareUser.find(session[:user_id])
+  end
+end

data/lib/generators/foursquare/authentication/templates/migrations/create_foursquare_user.rb

@@ -0,0 +1,11 @@
+class CreateFoursquareUsers < ActiveRecord::Migration
+  def change
+    create_table :foursquare_users do |t|
+      t.string :foursquare_id
+      t.string :access_token
+
+      t.timestamps
+    end
+    add_index :foursquare_users, :foursquare_id
+  end
+end

data/lib/generators/foursquare/authentication/templates/models/foursquare_client.rb

@@ -0,0 +1,51 @@
+# https://developer.foursquare.com/docs/
+class FoursquareClient
+  attr_accessor :access_token
+
+  def initialize(access_token)
+    @access_token = access_token
+  end
+
+  def user_info
+    @user_info ||= get('users/self').parsed['response']['user']
+  end
+
+  def user_id
+    user_info['id']
+  end
+
+  def user_name
+    [user_info['firstName'], user_info['lastName']].join(' ')
+  end
+
+  def oauth2_token
+    @oauth2_token ||= OAuth2::AccessToken.from_hash(self.class.oauth2_client, {access_token: access_token}.merge(mode: :query, param_name: 'oauth_token'))
+  end
+
+  def get(path, params = {})
+    oauth2_token.get(self.class.endpoint + path, params)
+  end
+
+  def post(path, params = {})
+    oauth2_token.post(self.class.endpoint + path, params)
+  end
+
+  def create_checkin_reply(checkin_id, options = {})
+    post("checkins/#{checkin_id}/reply", params: options)
+  end
+
+	class << self
+    def endpoint
+      'https://api.foursquare.com/v2/'
+    end
+
+    def oauth2_client
+      options = {
+        authorize_url: 'https://foursquare.com/oauth2/authenticate',
+        token_url:     'https://foursquare.com/oauth2/access_token',
+        raise_errors:  true,
+      }
+      OAuth2::Client.new("<%= settings['client_id'] %>", "<%= settings['client_secret'] %>", options)
+    end
+  end
+end

data/lib/generators/foursquare/authentication/templates/models/foursquare_user.rb

@@ -0,0 +1,23 @@
+class FoursquareUser < ActiveRecord::Base
+  def name
+    client.user_name
+  end
+
+  def client
+    @client ||= FoursquareClient.new(access_token)
+  end
+
+  class << self
+    def find_or_create_by_access_token(access_token)
+      client = FoursquareClient.new(access_token)
+
+      unless user = self.find_by_foursquare_id(client.user_id)
+        user = self.new
+        user.foursquare_id = client.user_id
+        user.access_token = client.access_token
+        user.save!
+      end
+      user
+    end
+  end
+end

data/lib/generators/foursquare/push/push_generator.rb

@@ -0,0 +1,17 @@
+module Foursquare
+  module Generators
+    class PushGenerator < Rails::Generators::Base
+      source_root File.expand_path("../templates", __FILE__)
+
+      desc "Receive push from foursquare into your app"
+
+      def add_routes
+        route "resources :checkins"
+      end
+
+      def create_checkins_controller
+        template 'controllers/checkins_controller.rb', File.join('app/controllers/', 'checkins_controller.rb')
+      end
+    end
+  end
+end

data/lib/generators/foursquare/push/templates/controllers/checkins_controller.rb

@@ -0,0 +1,11 @@
+class CheckinsController < ApplicationController
+  skip_before_filter :verify_authenticity_token
+
+  def create
+    checkin = JSON.parse(params['checkin'])
+    # TODO: verify push secret
+    user = FoursquareUser.find_by_foursquare_id(checkin['user']['id'])
+    user.client.create_checkin_reply(checkin['id'], text: "hello world!")
+    return head :ok
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: foursquare_rails_generators
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.2
   prerelease: 
 platform: ruby
 authors:
@@ -16,7 +16,19 @@ email: pierre@foursquare.com
 executables: []
 extensions: []
 extra_rdoc_files: []
-files: []
+files:
+- .gitignore
+- README.md
+- foursquare_rails_generators.gemspec
+- lib/foursquare_rails_generators.rb
+- lib/generators/foursquare/authentication/authentication_generator.rb
+- lib/generators/foursquare/authentication/templates/controllers/clients/foursquare_clients_controller.rb
+- lib/generators/foursquare/authentication/templates/controllers/users_controller.rb
+- lib/generators/foursquare/authentication/templates/migrations/create_foursquare_user.rb
+- lib/generators/foursquare/authentication/templates/models/foursquare_client.rb
+- lib/generators/foursquare/authentication/templates/models/foursquare_user.rb
+- lib/generators/foursquare/push/push_generator.rb
+- lib/generators/foursquare/push/templates/controllers/checkins_controller.rb
 homepage: http://rubygems.org/gems/foursquare_rails_generators
 licenses: []
 post_install_message: