vline-rails 0.0.6

data/lib/vline.rb

@@ -0,0 +1,196 @@
+require 'grape'
+require 'jwt'
+
+module Vline
+  mattr_accessor :app_id
+  @@app_id = nil
+
+  mattr_accessor :provider_id
+  @@provider_id = nil
+
+  mattr_accessor :provider_secret
+  @@provider_secret = nil
+
+  mattr_accessor :client_id
+  @@client_id = nil
+
+  mattr_accessor :client_secret
+  @@client_secret = nil
+
+  mattr_accessor :client_callback_url_base
+  @@client_callback_url_base = "https://api.vline.com/v1/auth"
+
+  mattr_accessor :access_token_exp_time
+  @@access_token_exp_time = nil
+
+  mattr_accessor :request_token_exp_time
+  @@request_token_exp_time = 10.minutes
+
+  mattr_accessor :login_token_exp_time
+  @@login_token_exp_time = 2.weeks
+
+  module Helper
+    def vline_launch(content, userId=nil)
+      link_to(content, {:action => 'launch', :controller => '/vline', :userId => userId}, :target => '_blank')
+    end
+  end
+
+  module AuthError
+    INVALID_REQUEST = "invalid_request"
+    ACCESS_DENIED = "access_denied"
+    UNAUTHORIZED_CLIENT= "unauthorized_client"
+    UNSUPPORTED_RESPONSE_TYPE = "unsupported_response_type"
+    INVALID_SCOPE = "invalid_scope"
+    SERVER_ERROR = "server_error"
+    TEMPORARILY_UNAVAILABLE = "temporarily_unavailable"
+  end
+
+  class API < Grape::API
+    version 'v1', :using => :path
+    format :json
+
+    def self.err_response(e, status)
+      Rack::Response.new({
+         'status' => status,
+         'message' => e.message
+       }.to_json, status)
+    end
+
+    rescue_from ActiveRecord::RecordNotFound do |e|
+      API.err_response(e, 404)
+    end
+
+    rescue_from :all do |e|
+      API.err_response(e, 500)
+    end
+
+    helpers do
+      def validate_request_token(token)
+        validate_token('req', token)
+      end
+
+      def validate_access_token(token)
+        validate_token('auth', token)
+      end
+
+      def validate_token(type, token)
+        obj = JWT.decode(token, JWT.base64url_decode(Vline.provider_secret))
+        if obj['type'] != type
+          raise 'Invalid token type'
+        end
+        if obj['exp'] && (Time.now.to_i > obj['exp'])
+          raise 'Token expired'
+        end
+        @current_user_id = obj['id']
+      end
+
+      def authenticate!
+        token = params[:access_token]
+        if !token
+          raise 'access_token not found'
+        end
+        validate_access_token(token)
+        @provider = VlineController.new(@current_user_id)
+      end
+
+      def userId
+        userId = params[:userId];
+        if userId == '@me'
+          @current_user_id
+        else
+          userId
+        end
+      end
+    end
+
+    desc "Returns an access token"
+    params do
+      requires :client_id, :type => String, :desc => 'OAuth client id'
+      requires :client_secret, :type => String, :desc => 'OAuth client secret'
+      requires :code, :type => String, :desc => 'Request token'
+    end
+    post '/oauth/access_token' do
+      if params[:client_id] != Vline.client_id
+        raise 'Invalid client_id'
+      end
+      if params[:client_secret] != Vline.client_secret
+        raise 'Invalid client_secret'
+      end
+      userId = validate_request_token(params[:code])
+      token = Vline.create_access_token(userId)
+      "access_token=#{token}&token_type=bearer"
+    end
+
+    desc "Returns a user's profile"
+    params do
+      requires :userId, :type => String, :desc => 'User ID of person'
+    end
+    get '/people/:userId/@self' do
+      authenticate!
+      @provider.get_profile(userId)
+    end
+
+    desc "Returns a collection of all contacts connected to a user"
+    params do
+      requires :userId, :type => String, :desc => 'User ID of person'
+    end
+    get '/people/:userId/@all' do
+      authenticate!
+      @provider.get_contact_profiles(userId)
+    end
+  end
+
+  def self.setup
+    yield self
+  end
+
+  def self.launch_url_for(userId, targetUserId=nil)
+    token = create_request_token(userId)
+    launch_url = auth_url
+    if targetUserId
+      launch_url += "/#{targetUserId}"
+    end
+    launch_url += "?code=#{token}"
+  end
+
+  def self.auth_url
+    "#{Vline.client_callback_url_base}/#{Vline.app_id}/#{Vline.provider_id}"
+  end
+
+  def self.auth_error_redirect_url(error, state)
+    url = auth_url + "?error=" + error
+    if state
+      url += "&state=" + state
+    end
+    url
+  end
+
+  def self.create_request_token(userId)
+      create_token('req', userId, Vline.request_token_exp_time)
+  end
+
+  def self.create_login_token(userId)
+    payload = {'sub'=> Vline.provider_id + ':' + userId.to_s, 'iss'=> Vline.provider_id}
+    add_expiration(payload, Vline.login_token_exp_time)
+    JWT.encode(payload, JWT.base64url_decode(Vline.provider_secret))
+  end
+
+  private
+    def self.add_expiration(payload, exp_time)
+      payload['exp'] = Time.now.to_i + exp_time
+    end
+
+    def self.create_access_token(userId)
+      create_token('auth', userId, Vline.access_token_exp_time)
+    end
+
+    def self.create_token(type, userId, exp_time)
+      payload = {'type' => type, 'id' => userId}
+      if exp_time
+        add_expiration(payload, exp_time)
+      end
+      JWT.encode(payload, JWT.base64url_decode(Vline.provider_secret))
+    end
+end
+
+ActionView::Base.send :include, Vline::Helper

data/lib/vline/version.rb

@@ -0,0 +1,3 @@
+module Vline
+  VERSION = "0.0.6"
+end

data/test/dummy/README.rdoc

@@ -0,0 +1,261 @@
+== Welcome to Rails
+
+Rails is a web-application framework that includes everything needed to create
+database-backed web applications according to the Model-View-Control pattern.
+
+This pattern splits the view (also called the presentation) into "dumb"
+templates that are primarily responsible for inserting pre-built data in between
+HTML tags. The model contains the "smart" domain objects (such as Account,
+Product, Person, Post) that holds all the business logic and knows how to
+persist themselves to a database. The controller handles the incoming requests
+(such as Save New Account, Update Product, Show Post) by manipulating the model
+and directing data to the view.
+
+In Rails, the model is handled by what's called an object-relational mapping
+layer entitled Active Record. This layer allows you to present the data from
+database rows as objects and embellish these data objects with business logic
+methods. You can read more about Active Record in
+link:files/vendor/rails/activerecord/README.html.
+
+The controller and view are handled by the Action Pack, which handles both
+layers by its two parts: Action View and Action Controller. These two layers
+are bundled in a single package due to their heavy interdependence. This is
+unlike the relationship between the Active Record and Action Pack that is much
+more separate. Each of these packages can be used independently outside of
+Rails. You can read more about Action Pack in
+link:files/vendor/rails/actionpack/README.html.
+
+
+== Getting Started
+
+1. At the command prompt, create a new Rails application:
+       <tt>rails new myapp</tt> (where <tt>myapp</tt> is the application name)
+
+2. Change directory to <tt>myapp</tt> and start the web server:
+       <tt>cd myapp; rails server</tt> (run with --help for options)
+
+3. Go to http://localhost:3000/ and you'll see:
+       "Welcome aboard: You're riding Ruby on Rails!"
+
+4. Follow the guidelines to start developing your application. You can find
+the following resources handy:
+
+* The Getting Started Guide: http://guides.rubyonrails.org/getting_started.html
+* Ruby on Rails Tutorial Book: http://www.railstutorial.org/
+
+
+== Debugging Rails
+
+Sometimes your application goes wrong. Fortunately there are a lot of tools that
+will help you debug it and get it back on the rails.
+
+First area to check is the application log files. Have "tail -f" commands
+running on the server.log and development.log. Rails will automatically display
+debugging and runtime information to these files. Debugging info will also be
+shown in the browser on requests from 127.0.0.1.
+
+You can also log your own messages directly into the log file from your code
+using the Ruby logger class from inside your controllers. Example:
+
+  class WeblogController < ActionController::Base
+    def destroy
+      @weblog = Weblog.find(params[:id])
+      @weblog.destroy
+      logger.info("#{Time.now} Destroyed Weblog ID ##{@weblog.id}!")
+    end
+  end
+
+The result will be a message in your log file along the lines of:
+
+  Mon Oct 08 14:22:29 +1000 2007 Destroyed Weblog ID #1!
+
+More information on how to use the logger is at http://www.ruby-doc.org/core/
+
+Also, Ruby documentation can be found at http://www.ruby-lang.org/. There are
+several books available online as well:
+
+* Programming Ruby: http://www.ruby-doc.org/docs/ProgrammingRuby/ (Pickaxe)
+* Learn to Program: http://pine.fm/LearnToProgram/ (a beginners guide)
+
+These two books will bring you up to speed on the Ruby language and also on
+programming in general.
+
+
+== Debugger
+
+Debugger support is available through the debugger command when you start your
+Mongrel or WEBrick server with --debugger. This means that you can break out of
+execution at any point in the code, investigate and change the model, and then,
+resume execution! You need to install ruby-debug to run the server in debugging
+mode. With gems, use <tt>sudo gem install ruby-debug</tt>. Example:
+
+  class WeblogController < ActionController::Base
+    def index
+      @posts = Post.all
+      debugger
+    end
+  end
+
+So the controller will accept the action, run the first line, then present you
+with a IRB prompt in the server window. Here you can do things like:
+
+  >> @posts.inspect
+  => "[#<Post:0x14a6be8
+          @attributes={"title"=>nil, "body"=>nil, "id"=>"1"}>,
+       #<Post:0x14a6620
+          @attributes={"title"=>"Rails", "body"=>"Only ten..", "id"=>"2"}>]"
+  >> @posts.first.title = "hello from a debugger"
+  => "hello from a debugger"
+
+...and even better, you can examine how your runtime objects actually work:
+
+  >> f = @posts.first
+  => #<Post:0x13630c4 @attributes={"title"=>nil, "body"=>nil, "id"=>"1"}>
+  >> f.
+  Display all 152 possibilities? (y or n)
+
+Finally, when you're ready to resume execution, you can enter "cont".
+
+
+== Console
+
+The console is a Ruby shell, which allows you to interact with your
+application's domain model. Here you'll have all parts of the application
+configured, just like it is when the application is running. You can inspect
+domain models, change values, and save to the database. Starting the script
+without arguments will launch it in the development environment.
+
+To start the console, run <tt>rails console</tt> from the application
+directory.
+
+Options:
+
+* Passing the <tt>-s, --sandbox</tt> argument will rollback any modifications
+  made to the database.
+* Passing an environment name as an argument will load the corresponding
+  environment. Example: <tt>rails console production</tt>.
+
+To reload your controllers and models after launching the console run
+<tt>reload!</tt>
+
+More information about irb can be found at:
+link:http://www.rubycentral.org/pickaxe/irb.html
+
+
+== dbconsole
+
+You can go to the command line of your database directly through <tt>rails
+dbconsole</tt>. You would be connected to the database with the credentials
+defined in database.yml. Starting the script without arguments will connect you
+to the development database. Passing an argument will connect you to a different
+database, like <tt>rails dbconsole production</tt>. Currently works for MySQL,
+PostgreSQL and SQLite 3.
+
+== Description of Contents
+
+The default directory structure of a generated Ruby on Rails application:
+
+  |-- app
+  |   |-- assets
+  |       |-- images
+  |       |-- javascripts
+  |       `-- stylesheets
+  |   |-- controllers
+  |   |-- helpers
+  |   |-- mailers
+  |   |-- models
+  |   `-- views
+  |       `-- layouts
+  |-- config
+  |   |-- environments
+  |   |-- initializers
+  |   `-- locales
+  |-- db
+  |-- doc
+  |-- lib
+  |   `-- tasks
+  |-- log
+  |-- public
+  |-- script
+  |-- test
+  |   |-- fixtures
+  |   |-- functional
+  |   |-- integration
+  |   |-- performance
+  |   `-- unit
+  |-- tmp
+  |   |-- cache
+  |   |-- pids
+  |   |-- sessions
+  |   `-- sockets
+  `-- vendor
+      |-- assets
+          `-- stylesheets
+      `-- plugins
+
+app
+  Holds all the code that's specific to this particular application.
+
+app/assets
+  Contains subdirectories for images, stylesheets, and JavaScript files.
+
+app/controllers
+  Holds controllers that should be named like weblogs_controller.rb for
+  automated URL mapping. All controllers should descend from
+  ApplicationController which itself descends from ActionController::Base.
+
+app/models
+  Holds models that should be named like post.rb. Models descend from
+  ActiveRecord::Base by default.
+
+app/views
+  Holds the template files for the view that should be named like
+  weblogs/index.html.erb for the WeblogsController#index action. All views use
+  eRuby syntax by default.
+
+app/views/layouts
+  Holds the template files for layouts to be used with views. This models the
+  common header/footer method of wrapping views. In your views, define a layout
+  using the <tt>layout :default</tt> and create a file named default.html.erb.
+  Inside default.html.erb, call <% yield %> to render the view using this
+  layout.
+
+app/helpers
+  Holds view helpers that should be named like weblogs_helper.rb. These are
+  generated for you automatically when using generators for controllers.
+  Helpers can be used to wrap functionality for your views into methods.
+
+config
+  Configuration files for the Rails environment, the routing map, the database,
+  and other dependencies.
+
+db
+  Contains the database schema in schema.rb. db/migrate contains all the
+  sequence of Migrations for your schema.
+
+doc
+  This directory is where your application documentation will be stored when
+  generated using <tt>rake doc:app</tt>
+
+lib
+  Application specific libraries. Basically, any kind of custom code that
+  doesn't belong under controllers, models, or helpers. This directory is in
+  the load path.
+
+public
+  The directory available for the web server. Also contains the dispatchers and the
+  default HTML files. This should be set as the DOCUMENT_ROOT of your web
+  server.
+
+script
+  Helper scripts for automation and generation.
+
+test
+  Unit and functional tests along with fixtures. When using the rails generate
+  command, template test files will be generated for you and placed in this
+  directory.
+
+vendor
+  External libraries that the application depends on. Also includes the plugins
+  subdirectory. If the app has frozen rails, those gems also go here, under
+  vendor/rails/. This directory is in the load path.