hide_and_seek 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: e7a671a6be853fb8677d508e509ac72018054a44
+  data.tar.gz: f8a7c55aa728293551a78c63a460a7dbb41f3d31
+SHA512:
+  metadata.gz: 2052593c7e833f02ff7786f2632144b4b78e62dd7e521fc105b46f238da99f7edd83a1423bddacd655eba8ebb375688afd2edfda029c5904c7f4d700c7b1ed00
+  data.tar.gz: 9984090693fabf0ccf834fbf33b091ee8896ceded5a7fe52514eb2ddc4a71f39b33e633eb6aafafc9f6bb4e676195e3fa0b74f36de86591a41b52fc364cc7072

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2015 BJ Clark
+
+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/Rakefile

@@ -0,0 +1,34 @@
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+Bundler.require
+
+require 'rdoc/task'
+
+RDoc::Task.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'HideAndSeek'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.rdoc')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+ 
+Bundler::GemHelper.install_tasks
+
+require 'combustion'
+task :environment do
+  Combustion.initialize!
+end
+Combustion::Application.load_tasks
+
+desc 'Default: run spec tests.'
+task :default => :spec
+
+require "rspec/core/rake_task"
+RSpec::Core::RakeTask.new(:spec) do |spec|
+  spec.pattern = Dir.glob(['spec/hide_and_seek/**/*'])
+  spec.rspec_opts = ['--backtrace']
+end
+

data/app/assets/javascripts/hide_and_seek/application.js

@@ -0,0 +1,13 @@
+// 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 any plugin's vendor/assets/javascripts directory 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_tree .

data/app/assets/stylesheets/hide_and_seek/application.css

@@ -0,0 +1,15 @@
+/*
+ * 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 any plugin's vendor/assets/stylesheets directory 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 bottom of the
+ * compiled file so the styles you add here take precedence over styles defined in any styles
+ * defined in the other CSS/SCSS files in this directory. It is generally better to create a new
+ * file per style scope.
+ *
+ *= require_tree .
+ *= require_self
+ */

data/app/controllers/hide_and_seek/application_controller.rb

@@ -0,0 +1,4 @@
+module HideAndSeek
+  class ApplicationController < ::ApplicationController
+  end
+end

data/app/controllers/hide_and_seek/items_controller.rb

@@ -0,0 +1,34 @@
+require_dependency "hide_and_seek/application_controller"
+
+module HideAndSeek
+  class ItemsController < ApplicationController
+    before_filter :determine_identifier
+
+    def show
+      respond_to do |format|
+        format.json {
+          render json: [display: $hide_and_seek.display?(params[:id], @id)]
+        }
+      end
+    end
+
+    def update
+      respond_to do |format|
+        format.json do
+          if $hide_and_seek.hide(params[:id], @id)
+            render status: 200, json: [true]
+          else
+            render status: 502, json: [false]
+          end
+        end
+      end
+
+    end
+
+    private
+    def determine_identifier
+      @id = params[:user_id] || current_user.id
+    end
+
+  end
+end

data/app/helpers/hide_and_seek/application_helper.rb

@@ -0,0 +1,4 @@
+module HideAndSeek
+  module ApplicationHelper
+  end
+end

data/app/helpers/hide_and_seek/item_helper.rb

@@ -0,0 +1,4 @@
+module HideAndSeek
+  module ItemHelper
+  end
+end

data/app/models/hide_and_seek/item.rb

@@ -0,0 +1,28 @@
+class HideAndSeek::Item
+  attr_accessor :item_name, :user_identifier
+
+  def initialize(storage)
+    @storage = storage
+  end
+
+  def display?(item_name, user_identifier)
+    @item_name = item_name
+    @user_identifier = user_identifier
+    return true if $redis.exists(key_name) == 1
+    return false
+  end
+
+  def hide(item_name, user_identifier)
+    @item_name = item_name
+    @user_identifier = user_identifier
+    if $redis.set(key_name, Time.now) == "OK"
+      return true
+    end
+    return false
+  end
+
+  def key_name
+    "#{@item_name}-#{@user_identifier}"
+  end
+
+end

data/app/views/layouts/hide_and_seek/application.html.erb

@@ -0,0 +1,14 @@
+<!DOCTYPE html>
+<html>
+<head>
+  <title>HideAndSeek</title>
+  <%= stylesheet_link_tag    "hide_and_seek/application", media: "all" %>
+  <%= javascript_include_tag "hide_and_seek/application" %>
+  <%= csrf_meta_tags %>
+</head>
+<body>
+
+<%= yield %>
+
+</body>
+</html>

data/config/routes.rb

@@ -0,0 +1,3 @@
+HideAndSeek::Engine.routes.draw do
+  resources :items, only: [:show, :update]
+end

data/lib/hide_and_seek.rb

@@ -0,0 +1,4 @@
+require "hide_and_seek/engine"
+
+module HideAndSeek
+end

data/lib/hide_and_seek/engine.rb

@@ -0,0 +1,13 @@
+module HideAndSeek
+  class Engine < ::Rails::Engine
+    isolate_namespace HideAndSeek
+
+    config.generators do |g|
+      g.test_framework :rspec, :fixture => false
+    end
+
+    Engine.routes.draw do
+      resources :items, only: [:show, :update]
+    end
+  end
+end

data/lib/hide_and_seek/version.rb

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

data/lib/tasks/hide_and_seek_tasks.rake

@@ -0,0 +1,4 @@
+# desc "Explaining what the task does"
+# task :hide_and_seek do
+#   # Task goes here
+# end

data/spec/hide_and_seek/controllers/items_controller_spec.rb

@@ -0,0 +1,55 @@
+require 'spec_helper'
+
+describe HideAndSeek::ItemsController, :type => :controller do
+  routes { HideAndSeek::Engine.routes }
+
+  let(:current_user){double("User", :id => 1)}
+
+  before do
+    allow(controller).to receive(:current_user).and_return(current_user)
+  end
+
+
+  context "#show" do
+    it "should check hide_and_seek with the id and the current user" do
+      expect($hide_and_seek).to receive(:display?).with("foo", 1).and_return(true)
+      get :show, id: "foo", format: :json
+    end
+    it "should render json display => true if successful" do
+      allow($hide_and_seek).to receive(:display?).and_return true
+      get :show, id: "foo", format: :json
+      expect(response.body).to eq([display: true].to_json)
+    end
+    it "should render json display => false if unsuccessful" do
+      allow($hide_and_seek).to receive(:display?).and_return false
+      get :show, id: "foo", format: :json
+      expect(response.body).to eq([display: false].to_json)
+    end
+    it "should params[:user_id] over current_user if sent" do
+      expect($hide_and_seek).to receive(:display?).with("foo", 9001).and_return(true)
+      get :show, id: "foo", format: :json, user_id: 9001
+    end
+  end
+
+  context "#update" do
+    it "should hide the item for the current_user" do
+      expect($hide_and_seek).to receive(:hide).with("foo", 1)
+      patch :update, id: "foo", format: :json
+    end
+    it "should render 200" do
+      allow($hide_and_seek).to receive(:hide).and_return true
+      patch :update, id: "foo", format: :json
+      expect(response.status).to eq(200)
+    end
+    it "should respond with 502 if it can't be saved." do
+      allow($hide_and_seek).to receive(:hide).and_return false
+      patch :update, id: "foo", format: :json
+      expect(response.status).to eq(502)
+    end
+    it "should params[:user_id] over current_user if sent" do
+      expect($hide_and_seek).to receive(:hide).with("foo", 9001).and_return(true)
+      patch :update, id: "foo", format: :json, user_id: 9001
+    end
+
+  end
+end

data/spec/hide_and_seek/models/item_spec.rb

@@ -0,0 +1,45 @@
+require 'spec_helper'
+
+describe HideAndSeek::Item, :type => :model do
+  before do
+    $redis = double(:exists => true, :set => "OK")
+  end
+
+  subject{HideAndSeek::Item.new $redis}
+
+  describe "#display?" do
+    it "should return true if key exists" do
+      allow($redis).to receive(:exists).with("foo-1").and_return 1
+      expect(subject.display?("foo", 1)).to be true
+    end
+    it "should return false if key doesn't exist" do
+      allow($redis).to receive(:exists).with("foo-1").and_return 0
+      expect(subject.display?("foo", 1)).to be false
+    end
+  end
+
+  describe "#key_name" do
+    it "should join the item name and the user identifier" do
+      subject.item_name = "foo"
+      subject.user_identifier = 1
+      expect(subject.key_name).to eql "foo-1"
+    end
+
+  end
+
+  describe "#hide" do
+    it "should receive a key with the current time" do
+      expect($redis).to receive(:set).with("foo-1", anything())
+      subject.hide("foo", 1)
+    end
+    it "should return true if successful" do
+      allow($redis).to receive(:set).with("foo-1", anything()).and_return "OK"
+      expect(subject.hide("foo", 1)).to be true
+    end
+
+    it "should return false if unsuccessful" do
+      allow($redis).to receive(:set).and_return "FALSE"
+      expect(subject.hide("foo", 1)).to be false
+    end
+  end
+end

data/spec/internal/README.rdoc

@@ -0,0 +1,28 @@
+== README
+
+This README would normally document whatever steps are necessary to get the
+application up and running.
+
+Things you may want to cover:
+
+* Ruby version
+
+* System dependencies
+
+* Configuration
+
+* Database creation
+
+* Database initialization
+
+* How to run the test suite
+
+* Services (job queues, cache servers, search engines, etc.)
+
+* Deployment instructions
+
+* ...
+
+
+Please feel free to use a different markup language if you do not plan to run
+<tt>rake doc:app</tt>.

data/spec/internal/Rakefile

@@ -0,0 +1,6 @@
+# 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__)
+
+Rails.application.load_tasks

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

@@ -0,0 +1,13 @@
+// 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 any plugin's vendor/assets/javascripts directory 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_tree .

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

@@ -0,0 +1,15 @@
+/*
+ * 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 any plugin's vendor/assets/stylesheets directory 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 bottom of the
+ * compiled file so the styles you add here take precedence over styles defined in any styles
+ * defined in the other CSS/SCSS files in this directory. It is generally better to create a new
+ * file per style scope.
+ *
+ *= require_tree .
+ *= require_self
+ */

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

@@ -0,0 +1,5 @@
+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
+end

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

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

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

@@ -0,0 +1,14 @@
+<!DOCTYPE html>
+<html>
+<head>
+  <title>Internal</title>
+  <%= stylesheet_link_tag    'application', media: 'all', 'data-turbolinks-track' => true %>
+  <%= javascript_include_tag 'application', 'data-turbolinks-track' => true %>
+  <%= csrf_meta_tags %>
+</head>
+<body>
+
+<%= yield %>
+
+</body>
+</html>

data/spec/internal/bin/bundle

@@ -0,0 +1,3 @@
+#!/usr/bin/env ruby
+ENV['BUNDLE_GEMFILE'] ||= File.expand_path('../../Gemfile', __FILE__)
+load Gem.bin_path('bundler', 'bundle')

data/spec/internal/bin/rails

@@ -0,0 +1,4 @@
+#!/usr/bin/env ruby
+APP_PATH = File.expand_path('../../config/application', __FILE__)
+require_relative '../config/boot'
+require 'rails/commands'