common: &common
\nhostname: localhost
\nport: 8091
\nusername:
\npassword:
\npool: defaultdevelopment:
\n<\u00a0 bucket: rvine<\/p>\n
test:
\n<\u00a0 bucket: rvine<\/p>\n
# set these environment variables on your production server
\nproduction:
\nhostname: <%<\/span>= ENV[<\/span>‘COUCHBASE_HOST’<\/span>]<\/span> %><\/span>
\nport: <%<\/span>= ENV[<\/span>‘COUCHBASE_PORT’<\/span>]<\/span> %><\/span>
\nusername: <%<\/span>= ENV[<\/span>‘COUCHBASE_USERNAME’<\/span>]<\/span> %><\/span>
\npassword: <%<\/span>= ENV[<\/span>‘COUCHBASE_PASSWORD’<\/span>]<\/span> %><\/span>
\npool: <%<\/span>= ENV[<\/span>‘COUCHBASE_POOL’<\/span>]<\/span> %><\/span>
\nbucket: <%<\/span>= ENV[<\/span>‘COUCHBASE_BUCKET’<\/span>]<\/span> %><\/span><\/p>\n<\/div>\n<\/div>\nOk, so now that that\u2019s done, we should have a Rails barebone project, that\u2019s hooked up to Couchbase as it\u2019s backend data store.\u00a0 Seem simple? That\u2019s because Couchbase-Model makes our life 1000x easier when it comes to data modeling!<\/p>\n
Now, the next thing we need to do is setup our User & Authentication classes.<\/em><\/strong><\/p>\nLet\u2019s create our User model first.\u00a0 Create the file \/app\/models\/user.rb<\/p>\n
\n
\n
class<\/span> User <<\/span> Couchbase::Model<\/span><\/p>\nattribute :name<\/span>
\nattribute :twit_username<\/span>
\nattribute :avatar<\/span><\/p>\ndef<\/span> self<\/span>.find_or_create_from_auth_hash<\/span>(<\/span>hash)<\/span>
\nuser = User.find_by_id<\/span>(<\/span>hash[<\/span>:uid<\/span>]<\/span>)<\/span>
\nunless<\/span> user
\nuser = User.create<\/span>!(<\/span>:id<\/span> =><\/span> hash[<\/span>:uid<\/span>]<\/span>,
\n:name<\/span> =><\/span> hash[<\/span>:info<\/span>]<\/span>[<\/span>:name<\/span>]<\/span>,
\n:twit_username<\/span> =><\/span> hash[<\/span>:info<\/span>]<\/span>[<\/span>:nickname<\/span>]<\/span>,
\n:avatar<\/span> =><\/span> hash[<\/span>:info<\/span>]<\/span>[<\/span>:image<\/span>]<\/span>)<\/span>
\nend<\/span>
\nuser
\nend<\/span>
\nend<\/span><\/p>\n<\/div>\n<\/div>\nThe attributes<\/strong> in this document are the fields we wish to include in our JSON document.\u00a0 We are collecting the user\u2019s Name, Twitter Username & Avatar.\u00a0 We need to give a unique key to each User in our database.\u00a0 In this instance, we are doing so by collecting the User\u2019s twitter UID and creating a hash from that to generate a key for our User document.\u00a0 It\u2019s important to remember that the key of every document in our database must be unique.\u00a0 Also, worth noting is the class we have created. \u2018find_or_create_from_auth_hash\u2019\u00a0 This class is doing exactly what it says on the tin! If a user exists; auth them. If not, create them from the Twitter details we receive.<\/p>\nYou will hopefully have noticed that we have chosen to use Twitter-Omniauth for this, to save us a hell of a lot of time instead writing an Auth class from scratch!\u00a0 The first thing to do here, is to head over to Twitter Dev and grab some application keys!\u00a0 If you have never done this before,\u00a0sign in with your Twitter account.\u00a0 Create a new application called \u2018rvine\u2019 and once you\u2019ve done that, you will be presented with 2 application keys.<\/p>\n
Create a config file in config\/initializers\/omniauth.rb.\u00a0 Once you have created this file, open it up and drop in the following code:<\/p>\n
\n
Rails.
application<\/span>.config<\/span>.middleware<\/span>.use<\/span> OmniAuth::Builder<\/span> do<\/span>
\nprovider :twitter<\/span>, “CONSUMER_KEY”<\/span>, “CONSUMER_SECRET”<\/span>
\nend<\/span><\/div>\n<\/div>\nThis should now mean we have Omniauth setup with our Twitter application keys, and almost ready to go.\u00a0 The next thing we need to do is create a route in our Rails application to handle the Authentication process.\u00a0 So, let\u2019s open up our config\/routes.rb file, and enter the following:<\/p>\n
\n
match
‘\/auth\/twitter\/callback’<\/span>, :to<\/span> =><\/span> ‘sessions#create’<\/span><\/div>\n<\/div>\nNow, we\u2019re telling Rails to send our Twitter Auth\u2019d callback to our sessions controller\u2026. What sessions controller?\u00a0\u00a0 We need to create that now.<\/p>\n
Go ahead and create file app\/controllers\/sessions_controller.rb<\/em><\/p>\n\n
class<\/span> SessionsController <<\/span> ApplicationController
\ndef<\/span> create
\nuser = User.find_or_create_from_auth_hash<\/span>(<\/span>auth_hash)<\/span>
\nsession[<\/span>:user_id<\/span>]<\/span> = user.id<\/span>
\nflash[<\/span>:success<\/span>]<\/span> = “Welcome to the club!”<\/span>
\nredirect_to dashboard_path
\nend<\/span>protected
\ndef<\/span> auth_hash
\nrequest.env<\/span>[<\/span>‘omniauth.auth’<\/span>]<\/span>
\nend<\/span>
\nend<\/span><\/p>\n<\/div>\n<\/div>\nAs you can see from this code, our \u2018Create\u2019 method is calling the class we defined in our User.rb to initialize a session when a User clicks to authenticate from the frontend, or create the User if they don\u2019t already exist.\u00a0 Once authenticated, we are redirecting the User to their Dashboard. (Which we will create soon!)<\/p>\n
Next up, let\u2019s update our application_controller.rb <\/em>to include a helper classes for our Authentication \u2013 including a helper method to define a Current_User and a helper method to ensure a User is Signed in.<\/p>\n\n
class<\/span> ApplicationController <<\/span> ActionController::Base<\/span>
\nprotect_from_forgerydef<\/span> authenticate!
\nif<\/span> signed_in?
\nreturn<\/span> true<\/span>
\nelse<\/span>
\nflash[<\/span>:error<\/span>]<\/span> = “You aren’t authorized to access this page”<\/span>
\nredirect_to(<\/span>root_path)<\/span>
\nend<\/span>
\nend<\/span><\/p>\ndef<\/span> current_user
\n@current_user<\/span> ||<\/span>= User.find_by_id<\/span>(<\/span>session[<\/span>:user_id<\/span>]<\/span>)<\/span>
\nend<\/span>
\nhelper_method :current_user<\/span><\/p>\ndef<\/span> signed_in?
\n!!current_user
\nend<\/span>
\nhelper_method :signed_in<\/span>?
\nend<\/span><\/p>\n<\/div>\n<\/div>\nNext up, we need to create the Dashboard for our Users to be redirected to upon authorisation.\u00a0 For this, let\u2019s use a Rails Generate command.<\/p>\n
\n
rails generate controller dashboards<\/div>\n<\/div>\n
Now, let\u2019s open up the file app\/controllers\/dashboards_controller.rb<\/em> and enter the following:<\/p>\n\n
\n
class<\/span> DashboardsController <<\/span> ApplicationController<\/p>\ndef<\/span> show
\nend<\/span><\/p>\nend<\/span><\/p>\n<\/div>\n<\/div>\nLet\u2019s open up our frontend view of the Dashboard, and edit that. In my case, it\u2019s going to be a HAML file.\u00a0 Regardless of whether you choose ERB or HAML, the file is going to look pretty much the same!\u00a0 In app\/views\/dashboards<\/em> – just create the file show.haml or show.erb.<\/p>\n\n
%<\/span>section#welcome<\/span>
\n.page<\/span>–<\/span>header
\n–<\/span> if<\/span> signed_in?
\n%<\/span>h1
\nHello, #{current_user.name}<\/span>
\n%<\/span>p<\/span>
\n%<\/span>img{<\/span>:src =><\/span> current_user.avatar<\/span>, :alt<\/span> =><\/span> “Avatar”<\/span>}<\/span>
\n%<\/span>p<\/span>= link_to(<\/span>“All vines”<\/span>, “\/vines”<\/span>)<\/span>
\n–<\/span> else<\/span>
\n%<\/span>h1
\nHello, stranger
\n%<\/span>p<\/span>
\n= link_to(<\/span>“Sign in with your twitter account”<\/span>, “\/auth\/twitter”<\/span>)<\/span>
\n%<\/span>p<\/span>
\n&<\/span>nbsp;<\/div>\n<\/div>\nNow we\u2019ve got our dashboard in place, we need to setup some more Routing, then we can go ahead and test things!\u00a0 Open up config\/routes.rb <\/em>and add the following:<\/p>\n\n
resource
:dashboard<\/span><\/div>\n<\/div>\nOnce you\u2019ve done that, save, run your app, and Authenticate as a user.<\/p>\n
Great! We can now see that our Authentication works, and our Users have a Dashboard.\u00a0 If we open up our Couchbase console, we should also see that a User has been created inside our Rvine bucket!<\/p>\n
Now we\u2019ve got our Users and Authentication in place, let\u2019s get onto the main part of the application: The Vine Videos!\u00a0 To get started here, we\u2019re going to need to create a model for Vines.\u00a0 Now, unfortunately, Couchbase-Model does not yet support the rails Generator on this action.\u00a0 So we need to manually create\u00a0 \/app\/models\/vine.rb<\/em><\/p>\nOnce we\u2019ve done that, let\u2019s fill in the following:<\/p>\n
\n