user_settings 0.0.1

checksums.yaml

@@ -0,0 +1,15 @@
+---
+!binary "U0hBMQ==":
+  metadata.gz: !binary |-
+    YmQ2NTljMjc0NjVmN2NiMTFjYjE4NDZiOTE2MzlmYzgxNTkyNWMxNA==
+  data.tar.gz: !binary |-
+    NGJhZDBjMzg5ODA2YmRhZDA4OWYwMWZjOTIyZjdlODgwZDc4ZGUxZQ==
+SHA512:
+  metadata.gz: !binary |-
+    NTU5NTRhMGJhN2JmZmVhYTc3MTNiNjMzMTdlYTkzZGU1ODEwMzQ2N2EwODJi
+    NzA0NmYwMWYxZTk2ZDk2NTk2YmNjNDJlZWUxYTI2ZDk3MzZlNWZlYWQ0ZWY2
+    ZTU4NTY0Nzg3MDExNDBhMTRjODMwMDM4M2NlNGM2MmNhYTM4MWY=
+  data.tar.gz: !binary |-
+    MTc1YzExY2I2Y2NmNDRlYmYxMTk5ZTUyYzM3ZTIyOTQ0MDUyMTQxZjA2ZWZk
+    YjkxZGEyMzk3NzZmMzAxMWI0MWRjZmMzZjM4NDZmNjQyZTE1YTZhNTkwYTYz
+    NjdmM2VkOTI1MzQ1MWNhZWI5YjlhMzcxYzlhYzU4OTBjMTRlY2M=

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/.travis.yml

@@ -0,0 +1,8 @@
+cache: bundler
+language:
+  - ruby
+install:
+  - 'bundle install'
+rvm:
+  - 1.9.3
+  - 2.0.0

data/Appraisals

@@ -0,0 +1,11 @@
+if RUBY_VERSION >= '2.0'
+  rails_versions = ['~> 3.2.13', '~> 4.0.0']
+else
+  rails_versions = ['~> 3.1.12', '~> 3.2.13']
+end
+
+rails_versions.each do |rails_version|
+  appraise "rails#{rails_version.slice(/\d+\.\d+/)}" do
+    gem 'rails', rails_version
+  end
+end

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in user_settings.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Dinesh Vasudevan
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,135 @@
+# UserSettings
+
+[![Code Climate](https://codeclimate.com/github/dinks/user_settings.png)](https://codeclimate.com/github/dinks/user_settings)
+
+[![Travis](https://api.travis-ci.org/dinks/user_settings.png)](https://travis-ci.org/dinks/user_settings)
+
+To save user based settings to redis, retrieve them and delete them.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'user_settings'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install user_settings
+
+## Usage
+
+The gem requires a Redis object to be passed for configuration as it stores the key:value in Redis
+
+### Configuration
+
+Create an initializer with configuration
+
+      require 'user_settings'
+
+      UserSettings.configure do |c|
+
+        redis = Redis.new({ host: "127.0.0.1", port: 6379, db: 0 })
+
+        c.redis_options = {redis_connection: redis} # Set the redis instance
+        c.base_path = 'my_custom_base_path/'        # Set a custom base path. 'usettings/' is default
+        c.route_drawer = MyCustomClass              # See UserSettings::RouteDrawers::Default
+        c.expiration_time = 2.months                # Change the expiration time. 3.months is default
+      end
+
+Redis could also be configured by setting the `redis_options` like
+
+      { host: 'localhost', port: 6379, db: 1 }
+
+The default routes are
+
+      get_user_settings GET    /usettings/:key(.:format) user_settings#show
+      set_user_settings POST   /usettings/:key(.:format) user_settings#create
+      set_once_user_settings PUT    /usettings/:key(.:format) user_settings#create_once
+      remove_user_settings DELETE /usettings/:key(.:format) user_settings#destroy
+
+The storage is with respect to user and requires a conventional `@current_user` object with an
+attribute `id` present. :|
+
+2 JavaScripts are to be included in the layout
+
+For the main javascript file. You might want to add this to the `config.assets.precompile` in `production.rb`
+
+      <%= javascript_include_tag_for_user_settings %>
+
+The user settings are to be initialized with your custom settings in places where you would use it
+
+      <%= init_user_settings %>
+
+
+### How to use ?
+
+The JavaScript used Promises and jQuery's Deferred which *emulates* Promises. Need to think about this more!
+
+To get a key
+
+      $.userSettings.
+        get('test').
+        then(function(d) {
+          // The response will have
+          // - success -> which is either true or false
+          // - value  -> value of the key if the success is true
+          console.log(d);
+        }).
+        fail(function(f) {
+          // The response will have
+          // - status -> 401 if unauthorized
+        });
+
+To Set a key with a Value
+
+      $.userSettings.
+        set('test', 'two').
+        then(function(d) {
+          // The response will have
+          // - success -> which is either true or false
+          // - value  -> "OK" if success is true
+          console.log(d);
+        }).
+        fail(function(f) {
+          // The response will have
+          // - status -> 401 if unauthorized
+        });
+
+To Set a key with a Value *ONCE*
+
+      $.userSettings.
+        setOnce('test', 'two').
+        then(function(d) {
+          // The response will have
+          // - success -> which is either true or false. It is true if the set is for the first time
+          // - value  -> "OK" if success is true
+          console.log(d);
+        }).
+        fail(function(f) {
+          // The response will have
+          // - status -> 401 if unauthorized
+        });
+
+To Remove a key:value
+
+      $.userSettings.
+        remove('test').
+        then(function(d) {
+          // There will not be any call to then !!
+        }).
+        fail(function(f) {
+          // The response will have
+          // - status -> 401 if unauthorized
+        });
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1,17 @@
+require 'rubygems'
+require 'bundler/setup'
+require 'bundler/gem_tasks'
+
+require 'rake'
+require 'rspec/core/rake_task'
+require 'appraisal'
+
+RSpec::Core::RakeTask.new(:spec)
+
+desc 'Default'
+task :default => [:all]
+
+desc 'Test the engine under all supported Rails versions'
+task all: ['appraisal:install'] do |t|
+  exec 'rake appraisal spec'
+end

data/app/assets/javascripts/user_settings.js

@@ -0,0 +1,78 @@
+/* global $, jQuery */
+
+(function($) {
+  $.userSettings = function(url) {
+    var baseUrl = url;
+
+    var executor = function(options) {
+      var deferred = new $.Deferred();
+
+      if ($.isFunction(options.callback)) {
+        deferred.then(options.callback);
+      }
+
+      var dataToSend = $.extend({
+                          t: Date.now()
+                        }, options.params);
+
+      $.ajax({
+        url: baseUrl + options.key,
+        dataType: 'json',
+        type: options.requestType,
+        data: dataToSend
+      }).then(function(data) {
+        deferred.resolve(data);
+      }).fail(function(data){
+        deferred.reject(data);
+      });
+
+      return deferred.promise();
+    };
+
+    // $.userSettings.get('test').then(function(a){console.log(a);}).fail(function(f){console.log(f);});
+    var get = function(key, callback) {
+      return executor({
+        key: key,
+        requestType: 'GET',
+        callback: callback
+      });
+    };
+
+    var set = function(key, value, callback) {
+      return executor({
+        key: key,
+        params: {
+          value: value
+        },
+        requestType: 'POST',
+        callback: callback
+      });
+    };
+
+    var setOnce = function(key, value, callback) {
+      return executor({
+        key: key,
+        params: {
+          value: value
+        },
+        requestType: 'PUT',
+        callback: callback
+      });
+    };
+
+    var remove = function(key, callback) {
+      return executor({
+        key: key,
+        requestType: 'DELETE',
+        callback: callback
+      });
+    };
+
+    return {
+      get: get,
+      set: set,
+      setOnce: setOnce,
+      remove: remove
+    };
+  };
+})(jQuery);

data/app/controllers/concerns/user_settings_concern.rb

@@ -0,0 +1,19 @@
+module UserSettings::UserSettingsConcern
+  extend ActiveSupport::Concern
+
+  included do
+
+    layout false
+
+    before_filter :check_if_authorized
+
+    private
+    def check_if_authorized
+      unless @current_user
+        head :unauthorized
+        false
+      end
+    end
+
+  end
+end

data/app/controllers/user_settings_controller.rb

@@ -0,0 +1,37 @@
+class UserSettingsController < ApplicationController
+  include UserSettings::UserSettingsConcern
+
+  def show
+    render json: create_presenter(:find).as_json
+  end
+
+  def create
+    render json: create_presenter(:create).as_json
+  end
+
+  def create_once
+    render json: create_presenter(:create, true).as_json
+  end
+
+  def destroy
+    render json: create_presenter(:destroy).as_json
+  end
+
+  private
+  def create_presenter(type, once=false)
+    creation =  case type
+                when :find
+                  UserSettings::Key.find(@current_user.id, params[:key])
+                when :destroy
+                  UserSettings::Key.destroy(@current_user.id, params[:key])
+                when :create
+                  if once
+                    UserSettings::Key.create(@current_user.id, params[:key], params[:value])
+                  else
+                    UserSettings::Key.create_or_update(@current_user.id, params[:key], params[:value])
+                  end
+                end
+
+    UserSettingsPresenter.new creation
+  end
+end

data/app/helpers/user_settings_helper.rb

@@ -0,0 +1,16 @@
+module UserSettingsHelper
+
+  def javascript_include_tag_for_user_settings
+    javascript_include_tag 'user_settings'
+  end
+
+  def init_user_settings
+    js = <<-JAVSCRIPT.strip_heredoc
+      <script type="text/javascript">
+        $.userSettings = $.userSettings('#{UserSettings.base_path}');
+      </script>
+    JAVSCRIPT
+    js.html_safe
+  end
+
+end

data/app/models/user_settings/key.rb

@@ -0,0 +1,30 @@
+module UserSettings
+  class Key
+    class << self
+      def create_or_update(user_id, key, value = nil)
+        UserSettings.redis.setex redisable_key(user_id, key), UserSettings.expiration_time, value
+      end
+
+      def create(user_id, key, value)
+        if find(user_id, key)
+          false
+        else
+          create_or_update(user_id, key, value)
+        end
+      end
+
+      def find(user_id, key)
+        UserSettings.redis.get redisable_key(user_id, key)
+      end
+
+      def destroy(user_id, key)
+        UserSettings.redis.del redisable_key(user_id, key)
+      end
+
+      private
+      def redisable_key(user_id, key)
+        "usersetting:#{user_id}:#{key}"
+      end
+    end
+  end
+end

data/app/presenters/user_settings_presenter.rb

@@ -0,0 +1,18 @@
+class UserSettingsPresenter
+  attr_reader :resource
+
+  def initialize(resource)
+    @resource = resource
+  end
+
+  def as_json
+    if @resource == false || @resource == true || @resource == nil
+      { success:  @resource || false }
+    else
+      {
+        success: true,
+        value: @resource
+      }
+    end
+  end
+end