RubyGems - motorurl - Versions diffs - 0.0.1 - Mend

motorurl 0.0.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (72) hide show

checksums.yaml +7 -0
data/MIT-LICENSE +20 -0
data/README.md +3 -0
data/Rakefile +18 -0
data/app/assets/stylesheets/motorurl/application.css +13 -0
data/app/controllers/motorurl/application_controller.rb +12 -0
data/app/controllers/motorurl/sensors_controller.rb +18 -0
data/app/helpers/motorurl/application_helper.rb +4 -0
data/app/views/layouts/motorurl/application.html.erb +14 -0
data/config/routes.rb +3 -0
data/lib/motorurl.rb +46 -0
data/lib/motorurl/capistrano/recipes.rb +33 -0
data/lib/motorurl/engine.rb +12 -0
data/lib/motorurl/railtie.rb +7 -0
data/lib/motorurl/registrar.rb +29 -0
data/lib/motorurl/report.rb +22 -0
data/lib/motorurl/transmitter.rb +41 -0
data/lib/motorurl/version.rb +3 -0
data/lib/tasks/motorurl_tasks.rake +11 -0
data/spec/controllers/sensors_controller_spec.rb +39 -0
data/spec/dummy/Capfile +28 -0
data/spec/dummy/Procfile +2 -0
data/spec/dummy/README.rdoc +28 -0
data/spec/dummy/Rakefile +6 -0
data/spec/dummy/app/assets/javascripts/application.js +13 -0
data/spec/dummy/app/assets/stylesheets/application.css +13 -0
data/spec/dummy/app/controllers/application_controller.rb +5 -0
data/spec/dummy/app/helpers/application_helper.rb +2 -0
data/spec/dummy/app/views/layouts/application.html.erb +14 -0
data/spec/dummy/bin/bundle +3 -0
data/spec/dummy/bin/rails +4 -0
data/spec/dummy/bin/rake +4 -0
data/spec/dummy/config.ru +4 -0
data/spec/dummy/config/application.rb +24 -0
data/spec/dummy/config/boot.rb +5 -0
data/spec/dummy/config/database.yml +25 -0
data/spec/dummy/config/deploy.rb +40 -0
data/spec/dummy/config/deploy/production.rb +43 -0
data/spec/dummy/config/deploy/staging.rb +43 -0
data/spec/dummy/config/environment.rb +5 -0
data/spec/dummy/config/environments/development.rb +29 -0
data/spec/dummy/config/environments/production.rb +80 -0
data/spec/dummy/config/environments/test.rb +36 -0
data/spec/dummy/config/initializers/backtrace_silencers.rb +7 -0
data/spec/dummy/config/initializers/filter_parameter_logging.rb +4 -0
data/spec/dummy/config/initializers/inflections.rb +16 -0
data/spec/dummy/config/initializers/mime_types.rb +5 -0
data/spec/dummy/config/initializers/motorurl.rb +10 -0
data/spec/dummy/config/initializers/secret_token.rb +12 -0
data/spec/dummy/config/initializers/session_store.rb +3 -0
data/spec/dummy/config/initializers/wrap_parameters.rb +14 -0
data/spec/dummy/config/locales/en.yml +23 -0
data/spec/dummy/config/routes.rb +6 -0
data/spec/dummy/db/development.sqlite3 +0 -0
data/spec/dummy/db/schema.rb +16 -0
data/spec/dummy/db/test.sqlite3 +0 -0
data/spec/dummy/lib/job.rb +19 -0
data/spec/dummy/log/development.log +4698 -0
data/spec/dummy/log/sidekiq.log +16656 -0
data/spec/dummy/public/404.html +58 -0
data/spec/dummy/public/422.html +58 -0
data/spec/dummy/public/500.html +57 -0
data/spec/dummy/public/favicon.ico +0 -0
data/spec/dummy/tmp/pids/server.pid +1 -0
data/spec/lib/registrar_spec.rb +63 -0
data/spec/lib/report_spec.rb +21 -0
data/spec/lib/transmitter_spec.rb +48 -0
data/spec/modules/motorurl_spec.rb +74 -0
data/spec/routing/engine_routes_spec.rb +21 -0
data/spec/spec_helper.rb +52 -0
data/spec/support/passwords.rb +5 -0
metadata +333 -0

checksums.yaml ADDED

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: f8fa8e072eff182c4023154eb6d06ca55641ba34
+  data.tar.gz: a34945c07b2f2a4734c3b165729a5f6fe7e6837b
+SHA512:
+  metadata.gz: 32576568c150f493b7970e3505f8c56959570758a4312577f611ed5e9264f9840c33d1b7fc65c47dd6d896e13bae645574c64746cac0e4ef21a78af9d3c39941
+  data.tar.gz: 211772320d12cfc748aeea3a5b25ad6f7dad257d8ff4147b7b5823dbca5f22489934a05443e884e5ab8dd705630a70419c90c6e8cf1c5527c15b94ff67b423fe

data/MIT-LICENSE ADDED

@@ -0,0 +1,20 @@
+Copyright 2014 YOURNAME
+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 ADDED

@@ -0,0 +1,3 @@
+= Motorurl
+This project rocks and uses MIT-LICENSE.

data/Rakefile ADDED

@@ -0,0 +1,18 @@
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+APP_RAKEFILE = File.expand_path("../spec/dummy/Rakefile", __FILE__)
+load 'rails/tasks/engine.rake'
+require 'rspec/core'
+require 'rspec/core/rake_task'
+Dir[File.join(File.dirname(__FILE__), 'tasks/**/*.rake')].each {|f| load f }
+Bundler::GemHelper.install_tasks
+desc "Run all specs in spec directory (excluding plugin specs)"
+RSpec::Core::RakeTask.new(:spec => 'app:db:test:prepare')
+task :default => :spec

data/app/assets/stylesheets/motorurl/application.css ADDED

@@ -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/app/controllers/motorurl/application_controller.rb ADDED

@@ -0,0 +1,12 @@
+module Motorurl
+  class ApplicationController < ActionController::Base
+    before_filter :validate_password
+    private
+      def validate_password
+        render(json: {}, status: :unauthorized) unless
+          Motorurl.validate_password(params[:password])
+      end
+  end
+end

data/app/controllers/motorurl/sensors_controller.rb ADDED

@@ -0,0 +1,18 @@
+module Motorurl
+  class SensorsController < ApplicationController
+    def create
+      Motorurl.process url_params
+      render json: {}, status: :ok
+    end
+    def show
+      render text: 'OK', status: :ok
+    end
+    private
+      def url_params
+        params.require(:url).permit(:url)
+      end
+  end
+end

data/app/helpers/motorurl/application_helper.rb ADDED

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

data/app/views/layouts/motorurl/application.html.erb ADDED

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

data/config/routes.rb ADDED

@@ -0,0 +1,3 @@
+Motorurl::Engine.routes.draw do
+  resource :sensor, only: [:create, :show]
+end

data/lib/motorurl.rb ADDED

@@ -0,0 +1,46 @@
+require 'hashie'
+require 'motorurl/engine'
+require 'motorurl/registrar'
+require 'motorurl/report'
+require 'rotp'
+module Motorurl
+  MissingJobClass = Class.new Exception
+  def self.configuration
+    @@configuration ||= Hashie::Mash.new
+  end
+  def self.configure
+    yield(configuration) if block_given?
+  end
+  def self.password_mux
+    @@mux ||= ROTP::TOTP.new configuration.shared_secret
+  end
+  def self.process(params)
+    configuration.sensor_job_class.perform params
+  end
+  def self.register
+    Register.register
+  end
+  def self.report(results)
+    Report.send results
+  end
+  def self.sensor_job_class
+    @@klass ||= begin
+      klass = configuration.sensor_job_class
+      klass = klass.safe_constantize if klass.is_a?(String)
+      klass or raise(MissingJobClass, 'no job class set')
+      klass
+    end
+  end
+  def self.validate_password(candidate)
+    password_mux.verify (candidate || 0).to_i
+  end
+end

data/lib/motorurl/capistrano/recipes.rb ADDED

@@ -0,0 +1,33 @@
+# encoding: utf-8
+# When installed as a plugin this is loaded automatically.
+#
+# When installed as a gem, you need to add
+#   require 'motorurl/capistrano/recipes'
+# to your deploy.rb
+#
+# The task will run on the primary app server unless no_release is true
+#
+require 'capistrano/version'
+def command
+  env     = fetch(:rack_env, nil) || fetch(:rails_env, nil)
+  release = fetch :latest_release
+  bundle  = fetch :bundle_cmd, 'bundle'
+  puts "cd #{release} && #{bundle} exec rake motorurl:register RACK_ENV=#{env}"
+end
+##
+# Cap version 3
+if defined?(Capistrano::VERSION)
+  namespace :motorurl do
+    desc "Register the sensor with Spiderman"
+    task :register do
+      on primary :app do
+        command
+      end
+    end
+  end
+else
+end

data/lib/motorurl/engine.rb ADDED

@@ -0,0 +1,12 @@
+module Motorurl
+  class Engine < ::Rails::Engine
+    isolate_namespace Motorurl
+    config.generators do |g|
+      g.test_framework      :rspec,        :fixture => false
+      g.fixture_replacement :factory_girl, :dir => 'spec/factories'
+      g.assets              false
+      g.helper              false
+    end
+  end
+end

data/lib/motorurl/railtie.rb ADDED

@@ -0,0 +1,7 @@
+module Motorurl
+  class MotorurlRailtie < Rails::Railtie
+    rake_tasks do
+      load 'tasks/motorurl_tasks.rake'
+    end
+  end
+end

data/lib/motorurl/registrar.rb ADDED

@@ -0,0 +1,29 @@
+require_relative 'transmitter'
+module Motorurl
+  class Registrar < Transmitter
+    attr_reader :friendly_name, :price, :callback_url, :canonical_name
+    def self.register(options = {})
+      new(options).xmit
+    end
+    def initialize(options = {})
+      super
+      @friendly_name  = params.fetch :friendly_name,  Motorurl.configuration.friendly_name
+      @price          = params.fetch :price,          (Motorurl.configuration.price || 0)
+      @callback_url   = params.fetch :callback_url,   Motorurl.configuration.callback_url
+      @canonical_name = params.fetch :canonical_name, Motorurl.configuration.canonical_name
+   end
+    private
+      def body
+        {
+          friendly_name:  friendly_name,
+          price:          price,
+          callback_url:   callback_url,
+          canonical_name: canonical_name }
+      end
+  end
+end

data/lib/motorurl/report.rb ADDED

@@ -0,0 +1,22 @@
+require_relative 'transmitter'
+module Motorurl
+  class Report < Transmitter
+    attr_reader :data
+    def self.report(data)
+      new(data).xmit
+    end
+    def initialize(data)
+      super
+      @data = data
+    end
+    private
+      def body
+        { data: data }
+      end
+  end
+end

data/lib/motorurl/transmitter.rb ADDED

@@ -0,0 +1,41 @@
+require 'httparty'
+module Motorurl
+  class Transmitter
+    include HTTParty
+    debug_output unless Rails.env.production?
+    attr_reader :base_uri, :params, :password, :response, :version
+    def initialize(options = {})
+      @params    = options.symbolize_keys
+      @base_uri  = params.fetch :base_uri, Motorurl.configuration.spiderman
+      @password  = params.fetch :password, Motorurl.password_mux.now
+      @version   = params.fetch :version,  Motorurl.configuration.version
+    end
+    def xmit
+      @response = self.class.post( '/sensor',
+        base_uri:                 base_uri,
+        body:                     extended_body,
+        headers:                  { 'Content-Type' => 'application/json' },
+        query_string_normalizer:  ->(query){query.to_json} )
+      self
+    end
+    private
+      def body
+        {}
+      end
+      def extended_body
+        body.merge(
+          canonical_name: Motorurl.configuration.canonical_name,
+          password:       password,
+          version:        version )
+      end
+  end
+end

data/lib/motorurl/version.rb ADDED

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

data/lib/tasks/motorurl_tasks.rake ADDED

@@ -0,0 +1,11 @@
+namespace :motorurl do
+  desc 'Generate a shared secret suitable for use with ROTP'
+  task :generate do
+    puts ROTP::Base32.random_base32
+  end
+  desc 'Register the sensor application'
+  task register: :environment do
+    Motorurl::Registrar.register
+  end
+end

data/spec/controllers/sensors_controller_spec.rb ADDED

@@ -0,0 +1,39 @@
+require 'spec_helper'
+module Motorurl
+  class DummyJob
+    def self.perform(params)
+    end
+  end
+  describe SensorsController do
+    routes { Motorurl::Engine.routes }
+    before(:all) do
+      Motorurl.configuration.sensor_job_class = DummyJob
+    end
+    let!(:password) { generate_one_time_password Motorurl.configuration.shared_secret }
+    let!(:params)   { { url: { url: 'whatever' }, password: password } }
+    describe 'Assigns' do
+      it 'works' do
+        post :create, params, format: :json
+        expect(response.status).to eq(200)
+      end
+    end
+    describe 'API Key enforcement' do
+      it 'rejects the request if the key does not match' do
+        params.merge! password: :fish
+        post :create, params,  format: :json
+        expect(response.status).to eq(401)
+      end
+      it 'accepts the request if the key matches' do
+        post :create, params, format: :json
+        expect(response.status).to eq(200)
+      end
+    end
+  end
+end

data/spec/dummy/Capfile ADDED

@@ -0,0 +1,28 @@
+# Load DSL and Setup Up Stages
+require 'capistrano/setup'
+# Includes default deployment tasks
+require 'capistrano/deploy'
+# Includes tasks from other gems included in your Gemfile
+#
+# For documentation on these, see for example:
+#
+#   https://github.com/capistrano/rvm
+#   https://github.com/capistrano/rbenv
+#   https://github.com/capistrano/chruby
+#   https://github.com/capistrano/bundler
+#   https://github.com/capistrano/rails/tree/master/assets
+#   https://github.com/capistrano/rails/tree/master/migrations
+#
+# require 'capistrano/rvm'
+# require 'capistrano/rbenv'
+# require 'capistrano/chruby'
+require 'capistrano/bundler'
+require 'capistrano/rails/assets'
+require 'capistrano/rails/migrations'
+# Loads custom tasks from `lib/capistrano/tasks' if you have any defined.
+Dir.glob('lib/capistrano/tasks/*.cap').each { |r| import r }
+require 'motorurl/capistrano/recipes'

data/spec/dummy/Procfile ADDED

	@@ -0,0 +1,2 @@
1	+ web: bundle exec rails server
2	+ worker: bundle exec sidekiq -L log/sidekiq.log

data/spec/dummy/README.rdoc ADDED

@@ -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>.