user_settings 0.0.1

data/config/routes.rb

@@ -0,0 +1,8 @@
+Rails.application.routes.draw do
+  if UserSettings.redis
+    get     UserSettings.route_drawer.match_get_settings
+    post    UserSettings.route_drawer.match_set_settings
+    put     UserSettings.route_drawer.match_set_once_settings
+    delete  UserSettings.route_drawer.match_remove_settings
+  end
+end

data/lib/user_settings/engine.rb

@@ -0,0 +1,13 @@
+module UserSettings
+  class Engine < Rails::Engine
+    initializer 'Require concerns path' do |app|
+      concerns_path = 'app/controllers/concerns'
+
+      unless app.paths.keys.include?(concerns_path)
+        app.paths.add(concerns_path)
+      end
+
+      require 'concerns/user_settings_concern'
+    end
+  end
+end

data/lib/user_settings/route_drawers/default.rb

@@ -0,0 +1,38 @@
+# Similar to https://github.com/thoughtbot/high_voltage/blob/master/lib/high_voltage.rb
+module UserSettings
+  module RouteDrawers
+    class Default
+      def self.match_get_settings
+        {
+          "/#{UserSettings.base_path}:key" => 'user_settings#show',
+          :as => :get_user_settings,
+          :format => :json
+        }
+      end
+
+      def self.match_set_once_settings
+        {
+          "/#{UserSettings.base_path}:key" => 'user_settings#create_once',
+          :as => :set_once_user_settings,
+          :format => :json
+        }
+      end
+
+      def self.match_set_settings
+        {
+          "/#{UserSettings.base_path}:key" => 'user_settings#create',
+          :as => :set_user_settings,
+          :format => :json
+        }
+      end
+
+      def self.match_remove_settings
+        {
+          "/#{UserSettings.base_path}:key" => 'user_settings#destroy',
+          :as => :remove_user_settings,
+          :format => :json
+        }
+      end
+    end
+  end
+end

data/lib/user_settings/version.rb

@@ -0,0 +1,3 @@
+module UserSettings
+  VERSION = "0.0.1"
+end

data/lib/user_settings.rb

@@ -0,0 +1,44 @@
+require "user_settings/version"
+require "user_settings/route_drawers/default"
+
+require 'active_support/core_ext/module/attribute_accessors'
+require 'active_support/core_ext'
+
+module UserSettings
+
+  # Redis options are
+  # * host
+  # * port
+  # * db
+  # * redis_connection - Give a connection directly
+  #
+  mattr_accessor :redis_options
+  @@redis_options = false
+  @@redis_connection = nil
+
+  mattr_accessor :base_path
+  @@base_path = 'usettings/'
+
+  mattr_accessor :route_drawer
+  @@route_drawer = UserSettings::RouteDrawers::Default
+
+  mattr_accessor :expiration_time
+  @@expiration_time = 3.months
+
+  def self.configure
+    yield self
+  end
+
+  def self.redis
+    if @@redis_options
+      @@redis_connection ||= @@redis_options.delete(:redis_connection)
+      if @@redis_connection == nil
+        @@redis_connection ||= Redis.new({:host => 'localhost', :port => 6379, :db => 1}.merge(@@redis_options))
+      end
+    end
+    @@redis_connection
+  end
+
+  require 'user_settings/engine' if defined?(Rails)
+
+end

data/spec/controllers/user_settings_controller_spec.rb

@@ -0,0 +1,173 @@
+require 'spec_helper'
+require 'json'
+
+describe UserSettingsController do
+
+  context 'with no current user' do
+
+    before do
+      ApplicationController.any_instance.stub(:set_current_user) { true }
+    end
+
+    context 'for get key' do
+      before { get :show, key: :test, format: :json }
+
+      it 'returns failure' do
+        response.should_not be_success
+      end
+
+    end
+
+    context 'for set key' do
+      before { post :create, key: :test, value: :test, format: :json }
+
+      it 'returns failure' do
+        response.should_not be_success
+      end
+
+    end
+
+    context 'for set once key' do
+      before { put :create_once, key: :test, value: :test, format: :json }
+
+      it 'returns failure' do
+        response.should_not be_success
+      end
+
+    end
+
+    context 'for delete key' do
+      before { delete :destroy, key: :test, format: :json }
+
+      it 'returns failure' do
+        response.should_not be_success
+      end
+
+    end
+
+  end
+
+  context 'with current user' do
+
+    let(:value) { 'test_value' }
+
+    context 'for get key' do
+      context 'when no value exists' do
+        before { get :show, key: :test, format: :json }
+
+        it 'returns success' do
+          response.should be_success
+        end
+
+        it 'should not find the key' do
+          parsed_body = JSON.parse(response.body)
+          parsed_body['success'].should == false
+        end
+      end
+
+      context 'when a value exists' do
+        before do
+          UserSettings::Key.stub(:find) { value }
+          get :show, key: :test, format: :json
+        end
+
+        it 'returns success' do
+          response.should be_success
+        end
+
+        it 'should find the key' do
+          parsed_body = JSON.parse(response.body)
+          parsed_body['value'].should == value
+        end
+      end
+    end
+
+    context 'for set key' do
+
+      before do
+        UserSettings::Key.stub(:create_or_update) { 'OK' }
+      end
+
+      context 'when no value exists' do
+        before do
+          UserSettings::Key.stub(:find) { false }
+          post :create, key: :test, value: :test, format: :json
+        end
+
+        it 'returns success' do
+          response.should be_success
+        end
+
+        it 'should have success in json' do
+          parsed_body = JSON.parse(response.body)
+          parsed_body['success'].should == true
+        end
+      end
+
+      context 'when value exists' do
+        before do
+          UserSettings::Key.stub(:find) { true }
+          post :create, key: :test, value: :test, format: :json
+        end
+
+        it 'returns success' do
+          response.should be_success
+        end
+
+        it 'should have success in json' do
+          parsed_body = JSON.parse(response.body)
+          parsed_body['success'].should == true
+        end
+      end
+
+    end
+
+    context 'for set once key' do
+
+      before do
+        UserSettings::Key.stub(:create_or_update) { 'OK' }
+      end
+
+      context 'when no value exists' do
+        before do
+          UserSettings::Key.stub(:find) { false }
+          put :create_once, key: :test, value: :test, format: :json
+        end
+
+        it 'returns success' do
+          response.should be_success
+        end
+
+        it 'should have success in json' do
+          parsed_body = JSON.parse(response.body)
+          parsed_body['success'].should == true
+        end
+      end
+
+      context 'when value exists' do
+        before do
+          UserSettings::Key.stub(:find) { true }
+          put :create_once, key: :test, value: :test, format: :json
+        end
+
+        it 'returns success' do
+          response.should be_success
+        end
+
+        it 'should have success in json' do
+          parsed_body = JSON.parse(response.body)
+          parsed_body['success'].should == false
+        end
+      end
+    end
+
+    context 'for delete key' do
+      before { delete :destroy, key: :test, format: :json }
+
+      it 'returns success' do
+        response.should be_success
+      end
+
+    end
+  end
+end

data/spec/dummy/Rakefile

@@ -0,0 +1,7 @@
+# Add your own tasks in files placed in lib/tasks ending in .rake,
+# for example lib/tasks/capistrano.rake, and they will automatically be available to Rake.
+
+require File.expand_path('../config/application', __FILE__)
+require 'rake'
+
+Dummy::Application.load_tasks

data/spec/dummy/app/assets/javascripts/application.js

@@ -0,0 +1,16 @@
+// This is a manifest file that'll be compiled into application.js, which will include all the files
+// listed below.
+//
+// Any JavaScript/Coffee file within this directory, lib/assets/javascripts, vendor/assets/javascripts,
+// or vendor/assets/javascripts of plugins, if any, can be referenced here using a relative path.
+//
+// It's not advisable to add code directly here, but if you do, it'll appear at the bottom of the
+// compiled file.
+//
+// Read Sprockets README (https://github.com/sstephenson/sprockets#sprockets-directives) for details
+// about supported directives.
+//
+//= require jquery
+//= require jquery_ujs
+//= require turbolinks
+//= require_tree .

data/spec/dummy/app/assets/javascripts/welcome.js.coffee

@@ -0,0 +1,3 @@
+# Place all the behaviors and hooks related to the matching controller here.
+# All this logic will automatically be available in application.js.
+# You can use CoffeeScript in this file: http://coffeescript.org/

data/spec/dummy/app/assets/stylesheets/application.css

@@ -0,0 +1,13 @@
+/*
+ * This is a manifest file that'll be compiled into application.css, which will include all the files
+ * listed below.
+ *
+ * Any CSS and SCSS file within this directory, lib/assets/stylesheets, vendor/assets/stylesheets,
+ * or vendor/assets/stylesheets of plugins, if any, can be referenced here using a relative path.
+ *
+ * You're free to add application-wide styles to this file and they'll appear at the top of the
+ * compiled file, but it's generally better to create a new file per style scope.
+ *
+ *= require_self
+ *= require_tree .
+ */

data/spec/dummy/app/assets/stylesheets/welcome.css.scss

@@ -0,0 +1,3 @@
+// Place all the styles related to the welcome controller here.
+// They will automatically be included in application.css.
+// You can use Sass (SCSS) here: http://sass-lang.com/

data/spec/dummy/app/controllers/application_controller.rb

@@ -0,0 +1,12 @@
+class ApplicationController < ActionController::Base
+  # Prevent CSRF attacks by raising an exception.
+  # For APIs, you may want to use :null_session instead.
+  protect_from_forgery with: :exception
+
+  before_filter :set_current_user
+
+  private
+  def set_current_user
+    @current_user = User.new('123456', SecureRandom.uuid)
+  end
+end

data/spec/dummy/app/controllers/welcome_controller.rb

@@ -0,0 +1,4 @@
+class WelcomeController < ApplicationController
+  def index
+  end
+end

data/spec/dummy/app/helpers/application_helper.rb

@@ -0,0 +1,2 @@
+module ApplicationHelper
+end

data/spec/dummy/app/helpers/welcome_helper.rb

@@ -0,0 +1,2 @@
+module WelcomeHelper
+end

data/spec/dummy/app/models/user.rb

@@ -0,0 +1,3 @@
+class User < Struct.new(:id, :uuid)
+
+end

data/spec/dummy/app/views/layouts/application.html.erb

@@ -0,0 +1,16 @@
+<!DOCTYPE html>
+<html>
+<head>
+  <title>UsettingsTest</title>
+  <%= stylesheet_link_tag    "application", media: "all", "data-turbolinks-track" => true %>
+  <%= javascript_include_tag "application", "data-turbolinks-track" => true %>
+  <%= javascript_include_tag_for_user_settings %>
+  <%= csrf_meta_tags %>
+</head>
+<body>
+
+<%= yield %>
+
+<%= init_user_settings %>
+</body>
+</html>

data/spec/dummy/app/views/welcome/index.html.erb

@@ -0,0 +1,2 @@
+<h1>Welcome#index</h1>
+<p>Find me in app/views/welcome/index.html.erb</p>

data/spec/dummy/config/application.rb

@@ -0,0 +1,16 @@
+require File.expand_path('../boot', __FILE__)
+
+require "active_model/railtie"
+require "action_controller/railtie"
+require "action_view/railtie"
+
+Bundler.require(:default, Rails.env)
+require "user_settings"
+
+module Dummy
+  class Application < Rails::Application
+    # For Ruby 1.9
+    config.encoding = "utf-8"
+    config.secret_key_base = 'Testme'
+  end
+end

data/spec/dummy/config/boot.rb

@@ -0,0 +1,9 @@
+require 'rubygems'
+gemfile = File.expand_path('../../../../Gemfile', __FILE__)
+
+if File.exist?(gemfile)
+  ENV['BUNDLE_GEMFILE'] = gemfile
+  require 'bundler/setup'
+end
+
+$:.unshift File.expand_path('../../../../lib', __FILE__)

data/spec/dummy/config/environment.rb

@@ -0,0 +1,5 @@
+# Load the rails application
+require File.expand_path('../application', __FILE__)
+
+# Initialize the rails application
+Dummy::Application.initialize!

data/spec/dummy/config/environments/test.rb

@@ -0,0 +1,31 @@
+Dummy::Application.configure do
+  # Settings specified here will take precedence over those in config/application.rb.
+
+  # The test environment is used exclusively to run your application's
+  # test suite. You never need to work with it otherwise. Remember that
+  # your test database is "scratch space" for the test suite and is wiped
+  # and recreated between test runs. Don't rely on the data there!
+  config.cache_classes = true
+
+  # Do not eager load code on boot. This avoids loading your whole application
+  # just for the purpose of running a single test. If you are using a tool that
+  # preloads Rails for running tests, you may have to set it to true.
+  config.eager_load = false
+
+  # Configure static asset server for tests with Cache-Control for performance.
+  config.serve_static_assets  = true
+  config.static_cache_control = "public, max-age=3600"
+
+  # Show full error reports and disable caching.
+  config.consider_all_requests_local       = true
+  config.action_controller.perform_caching = false
+
+  # Raise exceptions instead of rendering exception templates.
+  config.action_dispatch.show_exceptions = false
+
+  # Disable request forgery protection in test environment.
+  config.action_controller.allow_forgery_protection = false
+
+  # Print deprecation notices to the stderr.
+  config.active_support.deprecation = :stderr
+end