memcached-manager 0.2.3 → 0.3.0

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--backtrace

data/.travis.yml

@@ -0,0 +1,19 @@
+before_script:
+  - "export DISPLAY=:99.0"
+  - "sh -e /etc/init.d/xvfb start"
+
+before_install:
+  - gem install bundler
+
+script:
+  rake
+
+rvm:
+ - 1.9.3
+ - 2.0.0
+
+gemfile:
+  - Gemfile
+
+services:
+  - memcache

data/CONTRIBUTING.md

@@ -0,0 +1,28 @@
+== Running development mode
+
+    bundle install
+    rackup
+
+== Running the test suite
+
+First, make sure you have phantomjs installed if you want to run cukes tagged as @javascript(those who are in the features/webapp directory.
+
+Have `memcached` run on `localhost:11211` then run:
+
+    bundle exec rake
+
+== Roadmap(stuff you can do)
+
+* Develop frontend & artwork (in progress)
+* Favicon
+* Update API/frontend in order to use http statuses for errors, creation and so on.
+
+== Making a pull request?
+ 
+* Check out the latest master to make sure the feature hasn't been implemented or the bug hasn't been fixed yet.
+* Check out the issue tracker to make sure someone already hasn't requested it and/or contributed it.
+* Fork the project.
+* Start a feature/bugfix branch.
+* Commit and push until you are happy with your contribution.
+* Make sure to add tests for it. This is important so I don't break it in a future version unintentionally.
+* Please try not to mess with the Rakefile, version, or history. If you want to have your own version, or is otherwise necessary, that is fine, but please isolate to its own commit so I can cherry-pick around it.

data/Gemfile

@@ -0,0 +1,26 @@
+source 'https://rubygems.org'
+
+gem "sinatra"
+gem "sinatra-contrib"
+gem "dalli"
+gem "vegas"
+gem "thin"
+
+group :development do
+  gem "jeweler", "~> 1.8.8"
+end
+
+group :test do
+  gem "poltergeist"
+  gem "rack-test", :require => "rack/test"
+  gem "rspec"
+  gem "mocha"
+  gem "cucumber"
+  gem "capybara", :require => false
+  gem "faraday"
+end
+
+group :development, :test do
+  gem 'jasmine', "= 1.3.2"
+  gem "cucumber"
+end

data/Gemfile.lock

@@ -0,0 +1,143 @@
+GEM
+  remote: https://rubygems.org/
+  specs:
+    addressable (2.3.5)
+    backports (3.3.4)
+    builder (3.2.2)
+    capybara (2.1.0)
+      mime-types (>= 1.16)
+      nokogiri (>= 1.3.3)
+      rack (>= 1.0.0)
+      rack-test (>= 0.5.4)
+      xpath (~> 2.0)
+    childprocess (0.3.9)
+      ffi (~> 1.0, >= 1.0.11)
+    cliver (0.2.2)
+    cucumber (1.3.8)
+      builder (>= 2.1.2)
+      diff-lcs (>= 1.1.3)
+      gherkin (~> 2.12.1)
+      multi_json (>= 1.7.5, < 2.0)
+      multi_test (>= 0.0.2)
+    daemons (1.1.9)
+    dalli (2.6.4)
+    diff-lcs (1.2.4)
+    eventmachine (1.0.3)
+    faraday (0.8.8)
+      multipart-post (~> 1.2.0)
+    ffi (1.9.0)
+    gherkin (2.12.1)
+      multi_json (~> 1.3)
+    git (1.2.6)
+    github_api (0.10.1)
+      addressable
+      faraday (~> 0.8.1)
+      hashie (>= 1.2)
+      multi_json (~> 1.4)
+      nokogiri (~> 1.5.2)
+      oauth2
+    hashie (2.0.5)
+    highline (1.6.19)
+    httpauth (0.2.0)
+    jasmine (1.3.2)
+      jasmine-core (~> 1.3.1)
+      rack (~> 1.0)
+      rspec (>= 1.3.1)
+      selenium-webdriver (>= 0.1.3)
+    jasmine-core (1.3.1)
+    jeweler (1.8.8)
+      builder
+      bundler (~> 1.0)
+      git (>= 1.2.5)
+      github_api (= 0.10.1)
+      highline (>= 1.6.15)
+      nokogiri (= 1.5.10)
+      rake
+      rdoc
+    json (1.8.0)
+    jwt (0.1.8)
+      multi_json (>= 1.5)
+    metaclass (0.0.1)
+    mime-types (1.25)
+    mocha (0.14.0)
+      metaclass (~> 0.0.1)
+    multi_json (1.8.0)
+    multi_test (0.0.2)
+    multi_xml (0.5.5)
+    multipart-post (1.2.0)
+    nokogiri (1.5.10)
+    oauth2 (0.9.2)
+      faraday (~> 0.8)
+      httpauth (~> 0.2)
+      jwt (~> 0.1.4)
+      multi_json (~> 1.0)
+      multi_xml (~> 0.5)
+      rack (~> 1.2)
+    poltergeist (1.4.1)
+      capybara (~> 2.1.0)
+      cliver (~> 0.2.1)
+      multi_json (~> 1.0)
+      websocket-driver (>= 0.2.0)
+    rack (1.5.2)
+    rack-protection (1.5.0)
+      rack
+    rack-test (0.6.2)
+      rack (>= 1.0)
+    rake (10.1.0)
+    rdoc (4.0.1)
+      json (~> 1.4)
+    rspec (2.14.1)
+      rspec-core (~> 2.14.0)
+      rspec-expectations (~> 2.14.0)
+      rspec-mocks (~> 2.14.0)
+    rspec-core (2.14.5)
+    rspec-expectations (2.14.2)
+      diff-lcs (>= 1.1.3, < 2.0)
+    rspec-mocks (2.14.3)
+    rubyzip (0.9.9)
+    selenium-webdriver (2.35.1)
+      childprocess (>= 0.2.5)
+      multi_json (~> 1.0)
+      rubyzip (< 1.0.0)
+      websocket (~> 1.0.4)
+    sinatra (1.4.3)
+      rack (~> 1.4)
+      rack-protection (~> 1.4)
+      tilt (~> 1.3, >= 1.3.4)
+    sinatra-contrib (1.4.1)
+      backports (>= 2.0)
+      multi_json
+      rack-protection
+      rack-test
+      sinatra (~> 1.4.0)
+      tilt (~> 1.3)
+    thin (1.5.1)
+      daemons (>= 1.0.9)
+      eventmachine (>= 0.12.6)
+      rack (>= 1.0.0)
+    tilt (1.4.1)
+    vegas (0.1.11)
+      rack (>= 1.0.0)
+    websocket (1.0.7)
+    websocket-driver (0.3.0)
+    xpath (2.0.0)
+      nokogiri (~> 1.3)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  capybara
+  cucumber
+  dalli
+  faraday
+  jasmine (= 1.3.2)
+  jeweler (~> 1.8.8)
+  mocha
+  poltergeist
+  rack-test
+  rspec
+  sinatra
+  sinatra-contrib
+  thin
+  vegas

data/README.rdoc

@@ -24,7 +24,21 @@ or
 
 == Plugging memcached manager to an existing Rails app
 
-Todo.
+Just mount it in **config/routes.rb**:
+
+```ruby
+mount MemcachedManager::Routes, :at => '/mm'
+
+```
+So it will be accessible in the /mm route of your application.
+
+
+If you want to specify a different config than the defaults(localhost:11211) add an `.env` file with the following:
+
+```
+memcached_host: foo.bar
+memcached_port: 1337
+```
 
 == Requirements
 

data/Rakefile

@@ -0,0 +1,60 @@
+# encoding: utf-8
+
+require 'rubygems'
+require 'bundler'
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+require 'rake'
+
+require 'jeweler'
+Jeweler::Tasks.new do |gem|
+  # gem is a Gem::Specification... see http://docs.rubygems.org/read/chapter/20 for more options
+  gem.name = "memcached-manager"
+  gem.homepage = "http://github.com/thiagofm/memcached-manager"
+  gem.license = "MIT"
+  gem.summary = "A sinatra memcached-manager that allows you to view status, flush/view keys and so on. Also easily pluggable to a Rails app."
+  gem.description = "A sinatra memcached-manager that allows you to view status, flush/view keys and so on. Also easily pluggable to a Rails app."
+  gem.email = "thiagown@gmail.com"
+  gem.authors = ["Thiago Fernandes Massa"]
+  gem.test_files = Dir.glob('spec/**/*')
+  gem.executables = %w(memcached-manager)
+  
+  # dependencies defined in Gemfile
+end
+Jeweler::RubygemsDotOrgTasks.new
+
+# Tests
+begin
+  require 'jasmine'
+  load 'jasmine/tasks/jasmine.rake'
+rescue LoadError
+  task :jasmine do
+    abort "Jasmine is not available. In order to run jasmine, you must: (sudo) gem install jasmine"
+  end
+end
+
+require 'cucumber'
+require 'cucumber/rake/task'
+
+Cucumber::Rake::Task.new(:features) do |t|
+  t.cucumber_opts = "features --format pretty"
+end
+
+require 'rspec/core/rake_task'
+ 
+desc "Run specs"
+RSpec::Core::RakeTask.new do |t|
+  t.pattern = "./spec/**/*_spec.rb"
+end
+
+task :jasmineci do
+  system("export DISPLAY=:99.0 && bundle exec rake jasmine:ci")
+  raise "#{cmd} failed!" unless $?.exitstatus == 0
+end
+
+task :default => [:jasmineci, :features, :spec]

data/VERSION

@@ -0,0 +1 @@
+0.3.0

data/config.ru

@@ -1,10 +1,6 @@
 # Sinatra modules
 require './lib/webapp'
 require './lib/api'
+require './lib/routes'
 
-MemcachedManager::App = Rack::URLMap.new({
-  "/api" => MemcachedManager::API.new,
-  "/" => MemcachedManager::Webapp.new
-})
-
-run MemcachedManager
+run MemcachedManager::Routes

data/features/api/create_memcached_key.feature

@@ -0,0 +1,6 @@
+@api
+Feature: Create memcached pair
+  Scenario: Success
+    When I post some data to "/keys.json" in the API
+    Then I should receive a json response that it was saved successfully
+    And it should be saved in memcached

data/features/api/delete_memcached_key.feature

@@ -0,0 +1,6 @@
+@api
+Feature: Delete memcached key
+  Scenario: Success
+    Given there's the "username" memcached key avaiable
+    When I visit "/keys/username.json" in the API with the delete method
+    Then this key shouldn't exist.

data/features/api/list_memcached_keys.feature

@@ -0,0 +1,6 @@
+@api
+Feature: List memcached keys
+  Scenario: Success
+    Given there's some memcached keys avaiable
+    When I visit "/keys.json" in the API
+    Then I should receive a json response with those keys

data/features/api/set_memcached_info.feature

@@ -0,0 +1,5 @@
+@api
+Feature: Set memcached info
+  Scenario: Success
+    When I post configs to "/config.json" in the API
+    Then the memcached config should be set

data/features/api/show_memcached_key.feature

@@ -0,0 +1,10 @@
+@api
+Feature: Show memcached keys
+  Scenario: Success
+    Given there's the "username" memcached key avaiable
+    When I visit "/keys/username.json" in the API
+    Then I should receive a json response with this key
+
+  Scenario: Key doesn't exist
+    When I visit "/keys/username.json" in the API
+    Then I should receive a json telling me that the key doesn't exist

data/features/api/show_memcached_stats.feature

@@ -0,0 +1,5 @@
+@api
+Feature: Show memcached stats
+  Scenario: Success
+    When I visit "/stats.json" in the API
+    Then I should receive a json response with the memcached's current stats

data/features/api/update_memcached_key.feature

@@ -0,0 +1,7 @@
+@api
+Feature: Update memcached pair
+  Scenario: Success
+    Given there's the "username" memcached key avaiable
+    When I put some data to "/keys.json" in the API
+    Then I should receive a json response that it was edited successfully
+    And it should be updated in memcached

data/features/step_definitions/api/create_memcached_key.rb

@@ -0,0 +1,21 @@
+When /^I post some data to "(.*?)" in the API$/ do |route|
+  @data = { key: 'all.i.want.to.do', value: 'is.bang.bang.bang' }
+  @response = API.post do |req|
+    req.url "api/#{route}"
+    req.params = @data
+  end
+end
+
+Then /^I should receive a json response that it was saved successfully$/ do
+  @response.status.should be 200
+  response_json = JSON.parse(@response.body)
+  response_json.class.should eql Hash
+  response_json.keys.should_not include 'errors'
+  response_json.values.should include 'all.i.want.to.do'
+  response_json.keys.should include 'expired'
+end
+
+Then /^it should be saved in memcached$/ do
+  key = Memcached.get(@data[:key])
+  key.should == @data[:value]
+end

data/features/step_definitions/api/delete_memcached_key.rb

@@ -0,0 +1,7 @@
+When /^I visit "(.*?)" in the API with the delete method$/ do |route|
+  API.delete("api/#{route}")
+end
+
+Then /^this key shouldn't exist\.$/ do
+  Memcached.get('username').should eql nil
+end

data/features/step_definitions/api/list_memcached_keys.rb

@@ -0,0 +1,16 @@
+# encoding: utf-8
+
+Given /^there's some memcached keys avaiable$/ do
+  Memcached.set('foo', 'bar')
+  Memcached.set('ineed', 'togetalife')
+end
+
+When /^I visit "(.*?)" in the API$/ do |route|
+  @response = JSON.parse(API.get("api/#{route}").body)
+end
+
+Then /^I should receive a json response with those keys$/ do
+  @response.should_not equal nil
+  @response.last.values.should include 'foo'
+  @response.first.values.should include 'ineed'
+end

data/features/step_definitions/api/show_memcached_key.rb

@@ -0,0 +1,18 @@
+# Scenario: Success
+Given /^there's the "(.*?)" memcached key avaiable$/ do |key|
+  @key = key
+  Memcached.set(@key, 'John Doe')
+end
+
+Then /^I should receive a json response with this key$/ do
+  @response.class.should eql Hash
+  @response["key"].should include 'name'
+  @response["value"].should include 'John Doe'
+end
+
+# Scenario: Key doesn't exist
+Then /^I should receive a json telling me that the key doesn't exist$/ do
+  @response.class.should eql Hash
+  @response.keys.should include 'errors'
+  @response["errors"].should include 'Key not found.'
+end

data/features/step_definitions/api/show_memcached_stats.rb

@@ -0,0 +1,3 @@
+Then /^I should receive a json response with the memcached's current stats$/ do
+  @response.keys.should include("#{MemcachedConfigs[:host]}:#{MemcachedConfigs[:port]}")
+end

data/features/step_definitions/api/update_memcached_key.rb

@@ -0,0 +1,18 @@
+When /^I put some data to "(.*?)" in the API$/ do |route|
+  @data = { key: 'username', value: 'thiagofm' }
+  @response = API.put do |req|
+    req.url "api/#{route}"
+    req.params = @data
+  end
+end
+
+Then /^I should receive a json response that it was edited successfully$/ do
+  @response.status.should be 200
+  response_json = JSON.parse(@response.body)
+  response_json.class.should eql Hash
+  response_json.keys.should include 'key'
+end
+
+Then /^it should be updated in memcached$/ do
+  Memcached.get(@key).should eql 'thiagofm'
+end

data/features/step_definitions/set_memcached_info.rb

@@ -0,0 +1,25 @@
+When /^I post configs to "(.*?)" in the API$/ do |route|
+  @data = { 'host' => 'i.am', 'port' => '1337' }
+  @route = route
+
+  API.post do |req|
+    req.url "api/#{@route}"
+    req.params = @data
+  end
+end
+
+Then /^the memcached config should be set$/ do
+  response = API.get("api/#{@route}")
+  response_json = JSON.parse(response.body)
+
+  response.status.should be 200
+  response_json['host'].should eql @data['host']
+  response_json['port'].should eql @data['port']
+
+  # Workaround so the next feature don't use the current memcached configs
+  @data = { 'host' => MemcachedConfigs[:host], 'port' => MemcachedConfigs[:port] }
+  API.post do |req|
+    req.url "api/#{@route}"
+    req.params = @data
+  end
+end

data/features/step_definitions/webapp/create_memcached_key.rb

@@ -0,0 +1,10 @@
+When /^click on the X inside a div$/ do
+  within(".key-actions") do
+    find('.icon-remove').click
+  end
+  sleep 5
+end
+
+Then /^"(.*?)" key shouldn't exist in memcached$/ do |key|
+  Memcached.get(key).should be nil
+end

data/features/step_definitions/webapp/delete_memcached_key.rb

@@ -0,0 +1,16 @@
+When /^I visit "(.*?)"$/ do |route|
+  visit route
+end
+
+When /^fill in "(.*?)" with "(.*?)"$/ do |field, value|
+  fill_in(field, :with => value)
+end
+
+When /^click "(.*?)"$/ do |button|
+  click_button button
+end
+
+Then /^"(.*?)" key should have the "(.*?)" value in memcached$/ do |key, value|
+  sleep 1
+  Memcached.get(key).should == value
+end

data/features/step_definitions/webapp/edit_memcached_key.rb

@@ -0,0 +1,3 @@
+Given /^a key named "(.*?)" with the content "(.*?)" exists$/ do |key, value|
+  Memcached.set(key, value)
+end

data/features/step_definitions/webapp/list_memcached_keys.rb

@@ -0,0 +1,4 @@
+Then /^I should see "(.*?)" and "(.*?)" keys in the listing$/ do |key1, key2|
+  page.should have_content(key1)
+  page.should have_content(key2)
+end

data/features/step_definitions/webapp/show_memcached_key.rb

@@ -0,0 +1,4 @@
+Then /^I should be able to see the "(.*?)" key with the "(.*?)" value$/ do |key, value|
+  page.should have_content(key)
+  page.should have_content(value)
+end

data/features/step_definitions/webapp/show_memcached_stats.rb

@@ -0,0 +1,5 @@
+Then /^I should see memcached stats$/ do
+  page.should have_content('Stats')
+  page.should have_content("#{MemcachedConfigs[:host]}")
+  page.should have_content("#{MemcachedConfigs[:port]}")
+end

data/features/support/env.rb

@@ -0,0 +1,28 @@
+require 'cucumber'
+require 'capybara/cucumber'
+require 'faraday'
+require 'dalli'
+require 'rspec'
+require 'rspec/expectations'
+require 'capybara/poltergeist'
+require 'sinatra'
+
+Capybara.javascript_driver = :poltergeist
+
+World(RSpec::Matchers)
+
+# Files
+Dir.glob("lib/**/*.rb").each do |file|
+  require_relative "../../#{file}"
+end
+
+Capybara.app = Rack::Builder.parse_file(File.expand_path('../../../config.ru', __FILE__)).first
+
+API = Faraday.new do |conn| conn.adapter :rack, Rack::URLMap.new({
+    "/api" => MemcachedManager::API.new,
+    "/" => MemcachedManager::Webapp.new
+  })
+end
+
+MemcachedConfigs = { host: 'localhost', port: '11211' }
+Memcached        = Dalli::Client.new("#{MemcachedConfigs[:host]}:#{MemcachedConfigs[:port]}")

data/features/support/hooks.rb

@@ -0,0 +1,3 @@
+After do
+  Memcached.flush
+end

data/features/webapp/create_memcached_key.feature

@@ -0,0 +1,9 @@
+@webapp
+@javascript
+Feature: Create memcached pair
+  Scenario: Success
+    When I visit "#/new"
+    And fill in "Key" with "foo"
+    And fill in "Value" with "bar"
+    And click "Create"
+    Then "foo" key should have the "bar" value in memcached

data/features/webapp/delete_memcached_key.feature

@@ -0,0 +1,8 @@
+@webapp
+@javascript
+Feature: Delete memcached pair
+  Scenario: Success
+    Given a key named "foo" with the content "bar" exists
+    When I visit "#/"
+    And click on the X inside a div
+    Then "foo" key shouldn't exist in memcached

data/features/webapp/edit_memcached_key.feature

@@ -0,0 +1,9 @@
+@webapp
+@javascript
+Feature: Edit memcached pair
+  Scenario: Success
+    Given a key named "foo" with the content "bar" exists
+    When I visit "#/edit/foo"
+    And fill in "Value" with "baz"
+    And click "Edit"
+    Then "foo" key should have the "baz" value in memcached

data/features/webapp/list_memcached_keys.feature

@@ -0,0 +1,8 @@
+@webapp
+@javascript
+Feature: List memcached pair
+  Scenario: Success
+    Given a key named "foo" with the content "bar" exists
+    And a key named "fu" with the content "bar" exists
+    When I visit "#/"
+    Then I should see "foo" and "fu" keys in the listing

data/features/webapp/show_memcached_key.feature

@@ -0,0 +1,7 @@
+@webapp
+@javascript
+Feature: Show memcached key
+  Scenario: Success
+    Given a key named "foo" with the content "bar" exists
+    When I visit "#/key/foo"
+    Then I should be able to see the "foo" key with the "bar" value

data/features/webapp/show_memcached_stats.feature

@@ -0,0 +1,6 @@
+@webapp
+@javascript
+Feature: Show memcached stats
+  Scenario: Success
+    When I visit "#/"
+    Then I should see memcached stats