readonly_party 1.0.0

data/.gitignore

@@ -0,0 +1,19 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+vendor
+bin/httparty

data/Gemfile

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

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2012 Expected Behavior
+
+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,53 @@
+# ReadonlyParty
+
+An HTTParty where the resources never change, the points are made up,
+and everyboday wins.
+
+This is meant to be used in the same way as HTTParty and uses it under
+the covers. Except, when the ReadonlyParty module is included in a
+class, it explicitly disallows post, put, delete, and patch methods
+from being called on that class.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'read_only_party'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install read_only_party
+
+## Usage
+
+```ruby
+class ThingThatShouldOnlyRead
+  include ReadonlyParty
+end
+
+ThingThatShouldOnlyRead.get("http://www.example.com")     #=> some response
+ThingThatShouldOnlyRead.head("http://www.example.com")    #=> some response
+ThingThatShouldOnlyRead.options("http://www.example.com") #=> some response
+
+ThingThatShouldOnlyRead.put("http://www.example.com")     #=> HTTPMethodDisallowedException
+ThingThatShouldOnlyRead.post("http://www.example.com")    #=> HTTPMethodDisallowedException
+ThingThatShouldOnlyRead.delete("http://www.example.com")  #=> HTTPMethodDisallowedException
+```
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Added some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request
+
+## Meta
+
+Maintained by Expected Behavior
+
+Released under the MIT license. http://github.com/expected-behavior/readonly_party

data/Rakefile

@@ -0,0 +1,2 @@
+#!/usr/bin/env rake
+require "bundler/gem_tasks"

data/lib/readonly_party.rb

@@ -0,0 +1,30 @@
+require "readonly_party/version"
+require "httparty"
+
+class HTTPMethodDisallowedException < StandardError; end
+
+module ReadonlyParty
+  module ClassMethods
+    def post(*args)
+      raise HTTPMethodDisallowedException.new
+    end
+
+    def put(*args)
+      raise HTTPMethodDisallowedException.new
+    end
+
+    def delete(*args)
+      raise HTTPMethodDisallowedException.new
+    end
+
+    # Technically, HTTParty doesn't do patch yet. Enable... in the FUTURE!
+    # def patch(*args)
+    #   raise HTTPMethodDisallowedException.new
+    # end
+  end
+
+  def self.included(base)
+    base.send(:include, HTTParty)
+    base.send(:extend, ClassMethods)
+  end
+end

data/lib/readonly_party/version.rb

@@ -0,0 +1,3 @@
+module ReadonlyParty
+  VERSION = "1.0.0"
+end

data/readonly_party.gemspec

@@ -0,0 +1,23 @@
+# -*- encoding: utf-8 -*-
+$LOAD_PATH.push(File.expand_path "../lib", __FILE__)
+require "readonly_party/version"
+
+Gem::Specification.new do |gem|
+  gem.authors       = ["Joel Meador"]
+  gem.email         = ["joel@expectedbehavior.com"]
+  gem.description   = %q{This is meant to be used in the same way as HTTParty and uses it under the covers. Except, when the ReadonlyParty module is included in a class, it explicitly disallows post, put, delete, and patch methods from being called on that class.}
+  gem.summary       = %q{An HTTParty where the resources never change, the points are made up, and everyboday wins.}
+  gem.homepage      = "http://www.expectedbehavior.com"
+
+  gem.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  gem.files         = `git ls-files`.split("\n")
+  gem.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  gem.name          = "readonly_party"
+  gem.require_paths = ["lib"]
+  gem.version       = ReadonlyParty::VERSION
+
+  gem.add_dependency "httparty"
+
+  gem.add_development_dependency "minitest"
+  gem.add_development_dependency "webmock"
+end

data/test/readonly_party_test.rb

@@ -0,0 +1,62 @@
+require "minitest/autorun"
+require "webmock/minitest"
+
+require "readonly_party"
+
+class ReadonlyPartyObject; include ReadonlyParty; end
+
+class ReadonlyPartyTest < MiniTest::Unit::TestCase
+  describe "a boring party where everyone reads but no one writes" do
+
+    describe "readers" do
+      it "can get" do
+        stub_request(:get, /http:\/\/www.example.com/).to_return(:status => 200)
+        assert ReadonlyPartyObject.get("http://www.example.com")
+      end
+
+      it "can head" do
+        stub_request(:head, /http:\/\/www.example.com/).to_return(:status => 200)
+        assert ReadonlyPartyObject.head("http://www.example.com")
+      end
+
+      it "can options" do
+        stub_request(:options, /http:\/\/www.example.com/).to_return(:status => 200)
+        assert ReadonlyPartyObject.options("http://www.example.com")
+      end
+
+      # FUTURE!
+      # it "can trace" do
+      #   stub_request(:options, /http:\/\/www.example.com/).to_return(:status => 200)
+      #   assert ReadonlyPartyObject.trace("http://www.example.com")
+      # end
+    end
+
+    describe "writers" do
+      it "cannot post" do
+        assert_raises(HTTPMethodDisallowedException) {
+          ReadonlyPartyObject.post("http://www.example.com")
+        }
+      end
+
+      it "cannot put" do
+        assert_raises(HTTPMethodDisallowedException) {
+          ReadonlyPartyObject.put("http://www.example.com")
+        }
+      end
+
+      it "cannot delete" do
+        assert_raises(HTTPMethodDisallowedException) {
+          ReadonlyPartyObject.delete("http://www.example.com")
+        }
+      end
+
+      # FUTURE!
+      # it "cannot patch" do
+      #   assert_raises(HTTPMethodDisallowedException) {
+      #     ReadonlyPartyObject.patch("http://www.example.com")
+      #   }
+      # end
+    end
+
+  end
+end

metadata

@@ -0,0 +1,117 @@
+--- !ruby/object:Gem::Specification 
+name: readonly_party
+version: !ruby/object:Gem::Version 
+  hash: 23
+  prerelease: 
+  segments: 
+  - 1
+  - 0
+  - 0
+  version: 1.0.0
+platform: ruby
+authors: 
+- Joel Meador
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2012-02-16 00:00:00 -05:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: httparty
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :runtime
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: minitest
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: webmock
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id003
+description: This is meant to be used in the same way as HTTParty and uses it under the covers. Except, when the ReadonlyParty module is included in a class, it explicitly disallows post, put, delete, and patch methods from being called on that class.
+email: 
+- joel@expectedbehavior.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- .gitignore
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- lib/readonly_party.rb
+- lib/readonly_party/version.rb
+- readonly_party.gemspec
+- test/readonly_party_test.rb
+has_rdoc: true
+homepage: http://www.expectedbehavior.com
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.5.3
+signing_key: 
+specification_version: 3
+summary: An HTTParty where the resources never change, the points are made up, and everyboday wins.
+test_files: 
+- test/readonly_party_test.rb