sinatra-ajax_only 0.0.1

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/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 ymmtmsys
+
+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,52 @@
+# Sinatra::AjaxOnly
+
+Sinatra extensions for blocking non-AJAX requests.
+Provide **ajax_only** condition. Return 403 when request is not ajax.
+
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'sinatra-ajax_only'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install sinatra-ajax_only
+
+## Usage
+
+### for Classic Style Application
+
+``````Ruby
+# Only allow access via Ajax.
+get "/should/ajax", ajax_only do
+    "Ok!"
+end
+``````
+
+### for Modular Application
+
+``````Ruby
+class MyApp < Sinatra::Base
+
+    register Sinatra::AjaxOnly
+
+    # Only allow access via Ajax.
+    get "/should/ajax", ajax_only do
+        "Hey!"
+    end
+end
+``````
+
+## 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,13 @@
+require "bundler/gem_tasks"
+
+begin
+    require 'rspec/core/rake_task'
+    RSpec::Core::RakeTask.new(:spec) do |spec|
+        spec.pattern = 'spec/**/*_spec.rb'
+        spec.rspec_opts = ['-cfs']
+    end
+rescue LoadError => e
+    $stderr.puts "rspec/core is missing"
+end
+
+task :default => [:spec]

data/lib/sinatra-ajax_only.rb

@@ -0,0 +1 @@
+require "sinatra/ajax_only"

data/lib/sinatra/ajax_only.rb

@@ -0,0 +1,17 @@
+require "sinatra/base"
+
+module Sinatra
+    module AjaxOnly
+        def ajax_only
+            {:filter_xhr => true}
+        end
+
+        def filter_xhr(_)
+            condition do
+                halt 403 unless request.xhr?
+            end
+        end
+    end
+
+    register AjaxOnly
+end

data/lib/sinatra/ajax_only/version.rb

@@ -0,0 +1,5 @@
+module Sinatra
+  module AjaxOnly
+    VERSION = "0.0.1"
+  end
+end

data/sinatra-ajax_only.gemspec

@@ -0,0 +1,23 @@
+# -*- encoding: utf-8 -*-
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'sinatra/ajax_only/version'
+
+Gem::Specification.new do |gem|
+  gem.name          = "sinatra-ajax_only"
+  gem.version       = Sinatra::AjaxOnly::VERSION
+  gem.authors       = ["ymmtmsys"]
+  gem.email         = ["m2yamamoto@gmail.com"]
+  gem.description   = %q{Sinatra extensions for blocking non-AJAX requests.}
+  gem.summary       = gem.description
+  gem.homepage      = "https://github.com/ymmtmsys/sinatra-ajax_only"
+
+  gem.files         = `git ls-files`.split($/)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.require_paths = ["lib"]
+
+  gem.add_dependency 'sinatra', '>= 1.3.0'
+  gem.add_development_dependency 'rspec', '>= 0'
+  gem.add_development_dependency 'rack-test', '>= 0'
+end

data/spec/sinatra/ajax_only_spec.rb

@@ -0,0 +1,53 @@
+require 'spec_helper'
+
+describe Sinatra::AjaxOnly do
+
+    class TestApp < Sinatra::Base
+        register Sinatra::AjaxOnly
+
+        get '/require/ajax', ajax_only do
+            "ok"
+        end
+
+        get '/' do
+            "root"
+        end
+
+    end
+
+    def app
+        TestApp
+    end
+
+    describe "not require ajax request" do
+        describe 'non-ajax' do
+            before { get '/' }
+            subject { last_response.status }
+            it { should == 200 }
+        end
+
+        describe 'ajax' do
+            before do
+                get '/', {}, {"HTTP_X_REQUESTED_WITH" => "XMLHttpRequest"}
+            end
+            subject { last_response.status }
+            it { should == 200 }
+        end
+    end
+
+    describe "require ajax ajax" do
+        describe 'non-ajax' do
+            before { get '/require/ajax' }
+            subject { last_response.status }
+            it { should == 403 }
+        end
+
+        describe 'ajax' do
+            before do
+                get '/require/ajax', {}, {"HTTP_X_REQUESTED_WITH" => "XMLHttpRequest"}
+            end
+            subject { last_response.status }
+            it { should == 200 }
+        end
+    end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,26 @@
+# This file was generated by the `rspec --init` command. Conventionally, all
+# specs live under a `spec` directory, which RSpec adds to the `$LOAD_PATH`.
+# Require this file using `require "spec_helper"` to ensure that it is only
+# loaded once.
+#
+# See http://rubydoc.info/gems/rspec-core/RSpec/Core/Configuration
+
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'sinatra-ajax_only'
+require 'rspec'
+require 'rack/test'
+
+RSpec.configure do |config|
+  config.treat_symbols_as_metadata_keys_with_true_values = true
+  config.run_all_when_everything_filtered = true
+  config.filter_run :focus
+
+  config.include Rack::Test::Methods
+
+  # Run specs in random order to surface order dependencies. If you find an
+  # order dependency and want to debug it, you can fix the order by providing
+  # the seed, which is printed after each run.
+  #     --seed 1234
+  config.order = 'random'
+end

metadata

@@ -0,0 +1,106 @@
+--- !ruby/object:Gem::Specification
+name: sinatra-ajax_only
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- ymmtmsys
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-01-27 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: sinatra
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 1.3.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 1.3.0
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rack-test
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Sinatra extensions for blocking non-AJAX requests.
+email:
+- m2yamamoto@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/sinatra-ajax_only.rb
+- lib/sinatra/ajax_only.rb
+- lib/sinatra/ajax_only/version.rb
+- sinatra-ajax_only.gemspec
+- spec/sinatra/ajax_only_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/ymmtmsys/sinatra-ajax_only
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.24
+signing_key: 
+specification_version: 3
+summary: Sinatra extensions for blocking non-AJAX requests.
+test_files:
+- spec/sinatra/ajax_only_spec.rb
+- spec/spec_helper.rb