arsenicum 0.0.1 → 0.1.0

data/lib/arsenicum/version.rb

@@ -1,3 +1,3 @@
 module Arsenicum
-  VERSION = "0.0.1"
+  VERSION = '0.1.0'
 end

data/lib/generators/arsenicum/migration/migration_generator.rb

@@ -0,0 +1,32 @@
+class Arsenicum::MigrationGenerator
+  include Rails::Generators::Migration
+
+  def self.orm
+    Rails::Generators.options[:rails][:orm]
+  end
+  def self.source_root
+    File.join(File.dirname(__FILE__), 'templates', (orm.to_s unless orm.class.eql?(String)) )
+  end
+
+  def self.orm_has_migration?
+    [:active_record].include? orm
+  end
+
+  def self.next_migration_number(dirname)
+    if ActiveRecord::Base.timestamped_migrations
+      migration_number = Time.now.utc.strftime("%Y%m%d%H%M%S").to_i
+      migration_number += 1
+      migration_number.to_s
+    else
+      "%.3d" % (current_migration_number(dirname) + 1)
+    end
+  end
+
+  desc "This generator provides the tables which the Arsenicum uses."
+  def create_migration_file
+    if self.class.orm_has_migration?
+      migration_template 'migration.rb', 'db/migrate/create_arsenicum_queues'
+    end
+  end
+
+end

data/lib/generators/arsenicum/migration/templates/active_record/migration.rb

@@ -0,0 +1,15 @@
+class <%= migration_class_name %> < ActiveRecord::Migration
+  def change
+    create_table :j7w1_application_devices do |t|
+      t.string  :owner_type,          null: false
+      t.integer :owner_id,            null: false
+      t.string  :device_identifier,   null: false
+      t.string  :platform,            null: false
+      t.string  :device_endpoint_arn, null: true
+      t.boolean :disabled,            null: false,  default: false
+
+      t.index   [:owner_type, :owner_id]
+      t.index   [:device_identifier, :platform], unique: true
+    end
+  end
+end

data/spec/arsenicum/queueing/post_office_spec.rb

@@ -0,0 +1,123 @@
+require File.expand_path(File.join(File.dirname(__FILE__), '..', '..', 'spec_helper'))
+require 'yaml'
+
+class SampleA;end
+class SampleB;end
+class Default;end
+
+describe Arsenicum::Queueing::PostOffice do
+
+  subject do
+    yaml_path = File.expand_path(File.join(File.dirname(__FILE__), '..', '..', 'config/post_office_spec.yml'))
+    yaml_values = YAML.load(File.read(yaml_path, encoding: 'UTF-8'))
+    Arsenicum::Configuration.new(yaml_values['development']).post_office
+  end
+
+  describe :deliver_to do
+    shared_examples_for :correct_delivery do
+      let(:result){subject.queues[queue_name].receive}
+      let(:request_object) do
+        Arsenicum::Queueing::Request.new target: task[:worker], method_name: task[:method], arguments: task[:arguments]
+      end
+
+      before{subject.post request_object}
+
+      specify{expect(result).to include(:id)}
+      specify{expect(result[:body]).to eq(request_object.serialize)}
+    end
+
+    describe 'class method invocation' do
+      context do
+        let(:task){
+          {
+              worker: SampleB,
+              method: :hoge2,
+              arguments: [1]
+          }
+        }
+        let(:queue_name){:sample01}
+        it_should_behave_like :correct_delivery
+      end
+      context '' do
+        let(:task){
+          {
+              worker: SampleB,
+              method: :hoge1,
+              arguments: [1]
+          }
+        }
+        let(:queue_name){:sample_b}
+        it_should_behave_like :correct_delivery
+      end
+      context do
+        let(:task){
+          {
+              worker: SampleA,
+              method: :hoge1,
+              arguments: [1]
+          }
+        }
+        let(:queue_name){:sample_a}
+        it_should_behave_like :correct_delivery
+      end
+      context 'fallback to default' do
+        let(:task){
+          {
+              worker: Default,
+              method: :hoge1,
+              arguments: [1]
+          }
+        }
+        let(:queue_name){:default}
+        it_should_behave_like :correct_delivery
+      end
+    end
+
+    describe 'instance method invocation' do
+      context do
+        let(:task){
+          {
+              worker: SampleB.new,
+              method: :hoge2,
+              arguments: [1]
+          }
+        }
+        let(:queue_name){:sample02}
+        it_should_behave_like :correct_delivery
+      end
+      context '' do
+        let(:task){
+          {
+              worker: SampleB.new,
+              method: :hoge1,
+              arguments: [1]
+          }
+        }
+        let(:queue_name){:sample_b}
+        it_should_behave_like :correct_delivery
+      end
+      context do
+        let(:task){
+          {
+              worker: SampleA.new,
+              method: :hoge1,
+              arguments: [1]
+          }
+        }
+        let(:queue_name){:sample01}
+        it_should_behave_like :correct_delivery
+      end
+      context 'fallback to default' do
+        let(:task){
+          {
+              worker: Default.new,
+              method: :hoge1,
+              arguments: [1]
+          }
+        }
+        let(:queue_name){:default}
+        it_should_behave_like :correct_delivery
+      end
+    end
+  end
+end

data/spec/arsenicum/queueing/serializer_spec.rb

@@ -0,0 +1,70 @@
+require 'date'
+
+require File.expand_path(File.join(File.dirname(__FILE__), '..', '..', 'spec_helper'))
+
+describe Arsenicum::Queueing::Serializer do
+  subject{Object.new.extend(Arsenicum::Queueing::Serializer)}
+
+  describe [:serialize_object, :restore_object] do
+
+    shared_examples_for :serialize_restore do
+      specify{expect(subject.restore_object subject.serialize_object worker).to eq(worker)}
+    end
+
+    context :target_is_raw do
+      shared_examples_for :raw_object do
+        specify{expect(subject.serialize_object worker).to eq({type: 'raw', value: worker.inspect})}
+        it_should_behave_like :serialize_restore
+      end
+
+      context :target_is_integer do
+        let(:worker){1}
+        it_should_behave_like :raw_object
+      end
+
+      context :target_is_float do
+        let(:worker){1.3}
+        it_should_behave_like :raw_object
+      end
+
+      context :target_is_string do
+        let(:worker){"string"}
+        it_should_behave_like :raw_object
+      end
+
+      context :target_is_true do
+        let(:worker){true}
+        it_should_behave_like :raw_object
+      end
+
+      context :target_is_false do
+        let(:worker){false}
+        it_should_behave_like :raw_object
+      end
+
+      context :target_is_nil do
+        let(:worker){nil}
+        it_should_behave_like :raw_object
+      end
+
+    end
+
+    context :time_like do
+      shared_examples_for :date_time do
+        let(:worker){target_type.now}
+        specify{expect(subject.serialize_object worker).to eq({type: 'datetime', value: worker.strftime('%Y-%m-%dT%H:%M:%S %Z %z')})}
+        specify{expect(subject.restore_object(subject.serialize_object worker).to_i).to eq(worker.to_time.to_i)}
+      end
+
+      context :target_is_datetime do
+        let(:target_type){DateTime}
+        it_should_behave_like :date_time
+      end
+
+      context :target_is_time do
+        let(:target_type){Time}
+        it_should_behave_like :date_time
+      end
+    end
+  end
+end

data/spec/config/config.example.yml

@@ -0,0 +1,22 @@
+development:
+  engine: sqs
+  queues:
+    default:
+      concurrency: 10
+    sample01:
+      concurrency: 3
+      methods:
+        - 'SampleA#hoge1'
+        - 'SampleB.hoge2'
+      classes:
+        - 'ClassInvocation1'
+    sample02:
+      concurrency: 2
+      methods:
+        - 'SampleA#hoge2'
+        - 'SampleB.hoge1'
+  sqs:
+    account:
+      access_key_id: 'YOUR_ACCESS_KEY_ID'
+      secret_access_key: 'YOUR SECRET ACCESS KEY'
+      region: 'ap-northeast-1'

data/spec/config/post_office_spec.yml

@@ -0,0 +1,24 @@
+development:
+  engine: mock
+  log_file: '/dev/null'
+  queues:
+    default:
+      concurrency: 10
+    sample01:
+      concurrency: 3
+      methods:
+        - 'SampleA#hoge1'
+        - 'SampleB.hoge2'
+    sample02:
+      concurrency: 2
+      methods:
+        - 'SampleA#hoge2'
+        - 'SampleB#hoge2'
+    sample_a:
+      concurrency: 3
+      classes:
+        - SampleA
+    sample_b:
+      concurrency: 2
+      classes:
+        - SampleB

data/spec/rails_project/.gitignore

@@ -0,0 +1,16 @@
+# See https://help.github.com/articles/ignoring-files for more about ignoring files.
+#
+# If you find yourself ignoring temporary files generated by your text editor
+# or operating system, you probably want to add a global ignore instead:
+#   git config --global core.excludesfile '~/.gitignore_global'
+
+# Ignore bundler config.
+/.bundle
+
+# Ignore the default SQLite database.
+/db/*.sqlite3
+/db/*.sqlite3-journal
+
+# Ignore all logfiles and tempfiles.
+/log/*.log
+/tmp

data/spec/rails_project/Gemfile

@@ -0,0 +1,45 @@
+source 'https://rubygems.org'
+
+# Bundle edge Rails instead: gem 'rails', github: 'rails/rails'
+gem 'rails', '4.0.2'
+
+# Use sqlite3 as the database for Active Record
+gem 'sqlite3'
+
+# Use SCSS for stylesheets
+gem 'sass-rails', '~> 4.0.0'
+
+# Use Uglifier as compressor for JavaScript assets
+gem 'uglifier', '>= 1.3.0'
+
+# Use CoffeeScript for .js.coffee assets and views
+gem 'coffee-rails', '~> 4.0.0'
+
+# See https://github.com/sstephenson/execjs#readme for more supported runtimes
+# gem 'therubyracer', platforms: :ruby
+
+# Use jquery as the JavaScript library
+gem 'jquery-rails'
+
+# Turbolinks makes following links in your web application faster. Read more: https://github.com/rails/turbolinks
+gem 'turbolinks'
+
+# Build JSON APIs with ease. Read more: https://github.com/rails/jbuilder
+gem 'jbuilder', '~> 1.2'
+
+group :doc do
+  # bundle exec rake doc:rails generates the API under doc/api.
+  gem 'sdoc', require: false
+end
+
+# Use ActiveModel has_secure_password
+# gem 'bcrypt-ruby', '~> 3.1.2'
+
+# Use unicorn as the app server
+# gem 'unicorn'
+
+# Use Capistrano for deployment
+# gem 'capistrano', group: :development
+
+# Use debugger
+# gem 'debugger', group: [:development, :test]

data/spec/rails_project/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/rails_project/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__)
+
+ArsenicumSample::Application.load_tasks

data/spec/rails_project/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/rails_project/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/rails_project/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/rails_project/app/helpers/application_helper.rb

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