vline-rails 0.0.6 → 0.0.7

data/README.md

@@ -1,25 +1,25 @@
 # vLineRails Plugin
 
-vLineRails is a plugin that allows any Rails app to act as a vLine Identity Provider. Every vLine application instance
+vLineRails is a plugin that allows any Rails app to act as a vLine Identity Provider. Every vLine service
 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
+Learn more about vLine services 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
+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`
+2. Login to the [Developer Console](https://vline.com/developer/) and click `Create Service`.
 
-3. Choose a name for your application.
+3. Choose a name for your service.
 
 ## 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
+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):
 
@@ -27,7 +27,7 @@ with [Forward](http://forwardhq.com):
     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.
+your server is accessible at the forward URL.
 
 ## Installation (Rails 3.0)
 
@@ -41,33 +41,31 @@ your server is accessible at the forward url.
 
 1. Generate the provider by running the following command:
 
-        rails generate vline_provider --app-id=Your-App-Id --provider-secret=Your-App-Secret
+        rails generate vline_provider --service-id=Your-Service-Id --provider-secret=Your-Service-API-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.
+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
+## Configure your Web Client
 
-1. Open up the vLine Developer Console and choose `Hosted App Settings`.
+1. Open up the [vLine Developer Console](https://vline.com/developer/) and choose `Service 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:
+1. Click the `Edit` button and 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/`
 
+1. Further customization of the Web Client can be done by providing custom images in the `Web Client Settings`.
 
 ## Usage
 
-You can now launch into your vLine application from any view.
+You can now launch into your vLine Web Client from any view.
 
-To launch to the application home page:
+To launch to the Web Client home page:
 
     <%= vline_launch 'Launch' %>
 
@@ -86,5 +84,5 @@ To launch to a particular user's chat page:
         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`).
+services, one of which you can use to test out changes before rolling them out to your users (e.g.,
+`myservice` and `myservice-dev`).

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

@@ -2,8 +2,8 @@ require 'vline'
 
 Vline.setup do |config|
 
-  config.app_id = '<%= options.app_id %>'
-  config.provider_id = '<%= options.app_id %>'
+  config.service_id = '<%= options.service_id %>'
+  config.provider_id = '<%= options.service_id %>'
   config.client_id = '<%= options.client_id %>'
 
   # WARNING: Do not check these values into VCS!

data/lib/generators/vline_provider/vline_provider_generator.rb

@@ -5,8 +5,8 @@ class VlineProviderGenerator < Rails::Generators::NamedBase
 
   argument :name, :type => :string, :default => 'Vline'
 
-  class_option :app_id, :type => :string, :required => true,
-               :desc => 'Your vline application id'
+  class_option :service_id, :type => :string, :required => true,
+               :desc => 'Your vLine Service 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),
@@ -42,7 +42,7 @@ class VlineProviderGenerator < Rails::Generators::NamedBase
   end
 
   def output
-    say_status "App ID", "#{options[:app_id]}", :blue
+    say_status "Service ID", "#{options[:service_id]}", :blue
     say_status "Client ID", "#{options[:client_id]}", :blue
     say_status "Client Secret", "#{options[:client_secret]}", :blue
   end

data/lib/vline.rb

@@ -2,8 +2,8 @@ require 'grape'
 require 'jwt'
 
 module Vline
-  mattr_accessor :app_id
-  @@app_id = nil
+  mattr_accessor :service_id
+  @@service_id = nil
 
   mattr_accessor :provider_id
   @@provider_id = nil
@@ -154,7 +154,7 @@ module Vline
   end
 
   def self.auth_url
-    "#{Vline.client_callback_url_base}/#{Vline.app_id}/#{Vline.provider_id}"
+    "#{Vline.client_callback_url_base}/#{Vline.service_id}/#{Vline.provider_id}"
   end
 
   def self.auth_error_redirect_url(error, state)

data/lib/vline/version.rb

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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: vline-rails
 version: !ruby/object:Gem::Version
-  version: 0.0.6
+  version: 0.0.7
   prerelease: 
 platform: ruby
 authors:
@@ -11,7 +11,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-03-12 00:00:00.000000000 Z
+date: 2013-04-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails