vline-rails 0.0.6

data/LICENSE

@@ -0,0 +1,177 @@
+
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS

data/README.md

@@ -0,0 +1,90 @@
+# vLineRails Plugin
+
+vLineRails is a plugin that allows any Rails app to act as a vLine Identity Provider. Every vLine application instance
+has at least one registered Identity Provider, which is responsible for authenticating users and providing access to their
+contact lists and group memberships. The [Identity Provider interface](https://vline.com/developer/docs/identity_providers)
+is a subset of OAuth 2.0 and OpenSocial 2.5.
+
+Learn more about vLine applications at: https://vline.com/developer
+
+## Before you begin
+
+Before installing the plugin, you'll need to:
+
+1. Sign up for a vLine account at https://vline.com
+
+2. Login to the [Developer Console](https://vline.com/developer) and click `Create Application`
+
+3. Choose a name for your application.
+
+## Testing Locally
+
+For the vLine servers to be able to make api calls to your provider, your rails app will need to be running on a
+publicly accessible server. If your development server is behind a firewall, you can make it publicly accessible
+with [Forward](http://forwardhq.com):
+
+    gem install forward
+    forward 3000
+
+If your provider suddenly stops working, check to make sure forward is still running and
+your server is accessible at the forward url.
+
+## Installation (Rails 3.0)
+
+1. Add the plugin to your Gemfile:
+
+        gem 'vline-rails'
+
+1. Install it:
+
+        bundle install
+
+1. Generate the provider by running the following command:
+
+        rails generate vline_provider --app-id=Your-App-Id --provider-secret=Your-App-Secret
+    
+    Make note of the `Client Id` and `Client Secret` output by the command.
+
+1. Review the generated VlineProviderController, making any changes necessary to work with your models, authentication
+framework, and authorization framework.
+
+        vim app/controllers/vline_controller.rb
+
+## Configure your app
+
+1. Open up the vLine Developer Console and choose `Hosted App Settings`.
+
+1. You'll notice there are default URLs set for images used by the app. You can leave these as-is or change them to
+custom images for your app.
+
+1. Select `Custom OAuth` in the `Authorization` dropdown:
+    * Add the `Client Id` and `Client Secret` from the `rails generate` command you previously ran.
+    * Set the `Provider URL` to : `https://your-forward-url/_vline/api/v1/`
+    * Set the `OAuth URL` to: `https://your-forward-url/_vline/api/v1/oauth/`
+
+
+## Usage
+
+You can now launch into your vLine application from any view.
+
+To launch to the application home page:
+
+    <%= vline_launch 'Launch' %>
+
+To launch to a particular user's chat page:
+
+    <%= vline_launch 'Launch', @userId %>
+
+## Notes
+
+* If you are using the Deflater gem to gzip content, make sure it comes before `Rack::JSONP` in the `config.ru`:
+
+        require 'rack/jsonp'
+        use Rack::Deflater
+        use Rack::JSONP
+        require ::File.expand_path('../config/environment',  __FILE__)
+        run YourApp::Application
+
+* It's common to need to test changes before rolling them out directly to your users. We suggest creating two vLine
+applications, one of which you can use to test out changes before rolling them out to your users (e.g.,
+`myapp` and `myapp-dev`).

data/Rakefile

@@ -0,0 +1,38 @@
+#!/usr/bin/env rake
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+begin
+  require 'rdoc/task'
+rescue LoadError
+  require 'rdoc/rdoc'
+  require 'rake/rdoctask'
+  RDoc::Task = Rake::RDocTask
+end
+
+RDoc::Task.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'VlineRails'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.rdoc')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+
+
+
+Bundler::GemHelper.install_tasks
+
+require 'rake/testtask'
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'lib'
+  t.libs << 'test'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = false
+end
+
+
+task :default => :test

data/lib/generators/vline_provider/templates/controller.rb

@@ -0,0 +1,85 @@
+require 'digest/md5'
+require 'vline'
+
+class VlineController < ApplicationController
+  # require login
+  <%= login_filter %>
+
+  def initialize(currentUserId = nil)
+    if currentUserId
+      @current_user ||= find_user(currentUserId)
+    end
+  end
+
+  def launch(userId=nil)
+    if params[:userId]
+      userId = params[:userId]
+    end
+    redirect_to Vline.launch_url_for(current_user.id, userId)
+  end
+
+  def authorize
+    if params[:client_id] != Vline.client_id
+      redirect_to Vline.auth_error_redirect_url(Vline::AuthError::ACCESS_DENIED, params[:state])
+      return
+    end
+
+    if params[:response_type] != 'code'
+      redirect_to Vline.auth_error_redirect_url(Vline::AuthError::INVALID_REQUEST, params[:state])
+      return
+    end
+
+    # NOTE: we ignore "scope" and "redirect_uri"
+
+    code = Vline.create_request_token(current_user.id)
+
+    url = Vline.auth_url + "?code=" + code
+    if params[:state]
+      url += "&state=" + params[:state]
+    end
+    redirect_to url
+  end
+
+  def get_profile(userId)
+    user = find_user(userId)
+    profile_for(user)
+  end
+
+  def get_contact_profiles(userId)
+    users = find_contact_users(userId)
+    users.map { |u| profile_for(u) }
+  end
+
+  private
+
+  def find_user(userId)
+    User.find(userId)
+  end
+
+  def find_contact_users(userId)
+    User.all
+  end
+
+  def profile_for(user)
+    profile = {'id' => user.id, 'displayName' => user.name}
+    thumbnailUrl = thumbnail_url_for(user)
+    if thumbnailUrl
+      profile['thumbnailUrl'] = thumbnail_url_for(user)
+    end
+    profile
+  end
+
+  def thumbnail_url_for(user)
+    if user.respond_to?('thumbnail_url')
+      user.thumbnail_url
+    elsif user.respond_to?('email')
+      gravatar_url_for(user.email)
+    end
+  end
+
+  def gravatar_url_for(email)
+    # see http://en.gravatar.com/site/implement/images/
+    hash = Digest::MD5.hexdigest(email.downcase)
+    "https://www.gravatar.com/avatar/#{hash}?d=mm"
+  end
+end

data/lib/generators/vline_provider/templates/initializer.rb

@@ -0,0 +1,12 @@
+require 'vline'
+
+Vline.setup do |config|
+
+  config.app_id = '<%= options.app_id %>'
+  config.provider_id = '<%= options.app_id %>'
+  config.client_id = '<%= options.client_id %>'
+
+  # WARNING: Do not check these values into VCS!
+  config.client_secret = '<%= options.client_secret %>'
+  config.provider_secret = '<%= options.provider_secret %>'
+end

data/lib/generators/vline_provider/vline_provider_generator.rb

@@ -0,0 +1,60 @@
+require 'securerandom'
+
+class VlineProviderGenerator < Rails::Generators::NamedBase
+  source_root File.expand_path("../templates", __FILE__)
+
+  argument :name, :type => :string, :default => 'Vline'
+
+  class_option :app_id, :type => :string, :required => true,
+               :desc => 'Your vline application id'
+  class_option :client_id, :type => :string, :default => SecureRandom.urlsafe_base64(32),
+               :desc => 'OAUTH client ID'
+  class_option :client_secret, :type => :string, :default => SecureRandom.urlsafe_base64(32),
+               :desc => 'OAUTH client secret'
+  class_option :provider_secret, :type => :string, :required => true,
+               :desc => 'Secret string for signing login and OAUTH tokens. This value comes from developer console.'
+
+  desc 'Creates a VlineProvider controller.'
+
+  def check_class_collisions
+    class_collisions class_path, "#{class_name}Controller"
+  end
+
+  def copy_controller_file
+    template 'controller.rb', File.join('app/controllers', class_path, "#{file_name}_controller.rb")
+  end
+
+  def copy_initializer_file
+    template 'initializer.rb', "config/initializers/#{file_name}.rb"
+  end
+
+  def add_routes
+    route "match '_vline/launch' => 'vline#launch'"
+    route "match '_vline/api/v1/oauth/authorize' => 'vline#authorize'"
+    route "mount Vline::API => '_vline/api'"
+  end
+
+  def add_jsonp_support
+    line = "# This file is used by Rack-based servers to start the application."
+    gsub_file 'config.ru', /(#{Regexp.escape(line)})/mi do |match|
+      "#{match}\nrequire 'rack/jsonp'\nuse Rack::JSONP\n"
+    end
+  end
+
+  def output
+    say_status "App ID", "#{options[:app_id]}", :blue
+    say_status "Client ID", "#{options[:client_id]}", :blue
+    say_status "Client Secret", "#{options[:client_secret]}", :blue
+  end
+
+  protected
+    def login_filter
+      if File.exist? 'config/initializers/devise.rb'
+        "before_filter :authenticate_user!"
+      elsif File.exist? 'config/initializers/authlogic.rb'
+        "before_filter :require_user"
+      else
+        "before_filter :login_required"
+      end
+    end
+end