iron_hide-storage-couchdb_adapter 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: ac941912f46eb6ad9672808497c3d92dd2e2d0ba
+  data.tar.gz: c3ec87e541bd3a7ecf7a7340726c93d41919c762
+SHA512:
+  metadata.gz: c6fe271465762e93e01a837745726a29b4b3263d1941c0ec53ffc49a48719e7a1e57bd9095f875f299d32a608d9d3c0a55125592b792a4dd4ce37a8959413363
+  data.tar.gz: 2716bd33b4a6ade2a311287bb399731d0e7e046f0ddc336ab07c245fed0910c95adb99d83aefd91c91ccbf81c077a8fae0a2d096483ded06f7bde8affdd771f5

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
+.ruby-gemset
+.ruby-version

data/Gemfile

@@ -0,0 +1,5 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in iron_hide-storage-couchdb_adapter.gemspec
+gemspec
+

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 The Climate Corporation
+
+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,90 @@
+# IronHide::Storage::CouchdbAdapter
+
+A CouchDB adapter for the IronHide authorization library.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'iron_hide-storage-couchdb_adapter'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install iron_hide-storage-couchdb_adapter
+
+## Setting up a CouchDB server
+
+Assuming that you don't have a CouchDB server, this project comes with a few helper Rake tasks.
+
+### Setup a local Couchdb server
+The best resource for getting started with CouchDB is http://guide.couchdb.org/
+
+Using brew:
+
+```
+brew install couchdb
+couchdb # Starts the server
+```
+
+
+### Setup the server for use with IronHide
+To install the helper Rake tasks:
+
+```ruby
+# Rakefile
+require 'rake'
+require 'iron_hide/couchdb_tasks'
+```
+
+To create a new database, either use the HTTP API, Futon, or this simple Rake task:
+
+```
+bundle exec rake iron_hide:create_db\['http://127.0.0.1:5984/rules'\]
+```
+
+To upload some rules to this database:
+
+```
+bundle exec rake iron_hide:load_rules\['/absolute/path/file.json','http://127.0.0.1:5984/rules'\]
+```
+
+Note: Required step
+Setup the required views
+
+```
+bundle exec iron_hide:rake create_views\['http://127.0.0.1:5984/rules'\]
+```
+
+## Usage
+
+```ruby
+require 'iron_hide'
+require 'iron_hide/storage/couchdb_adapter'
+
+IronHide.config do |c|
+    c.adapter          = :couchdb
+    c.namespace        = 'TestApp'
+    c.couchdb_server   = 'http://127.0.0.1:5984' # Default
+    c.couchdb_database = 'rules' # Default
+end
+```
+
+## Contributing
+
+1. Fork it ( http://github.com/<my-github-username>/iron_hide-storage-couchdb_adapter/fork )
+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
+
+## Further Reading
+* [Tim Anglade](https://twitter.com/timanglade)
+http://www.slideshare.net/timanglade/couchdb-ruby-youre-doing-it-wrong
+
+## TODO
+- Caching
+- Tests

data/Rakefile

@@ -0,0 +1,12 @@
+require "bundler/gem_tasks"
+require 'rake/testtask'
+
+Rake::TestTask.new do |t|
+    t.libs << 'spec'
+    t.test_files = FileList['spec/**/*_spec.rb']
+    t.verbose = true
+end
+
+desc 'Run tests'
+task :default => :test
+

data/iron_hide-storage-couchdb_adapter.gemspec

@@ -0,0 +1,27 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'iron_hide/storage/couchdb_adapter/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "iron_hide-storage-couchdb_adapter"
+  spec.version       = IronHide::Storage::CouchdbAdapter::VERSION
+  spec.authors       = ["Alan Cohen"]
+  spec.email         = ["acohen@climate.com"]
+  spec.summary       = %q{A CouchDB adapter for IronHide Authorization}
+  spec.description   = %q{Requires IronHide}
+  spec.homepage      = ""
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1"
+  spec.add_development_dependency "iron_hide"
+  spec.add_development_dependency "rake", "~> 10"
+  spec.add_development_dependency "rspec", "~> 2.14"
+  spec.add_runtime_dependency "typhoeus", "~> 0.6.8"
+  spec.add_runtime_dependency "multi_json"
+  spec.add_runtime_dependency "couchrest", "~> 1.2"
+end

data/lib/iron_hide/couchdb_tasks.rb

@@ -0,0 +1,72 @@
+require 'couchrest'
+require 'typhoeus'
+require 'multi_json'
+
+module IronHide
+  class CouchDbTasks
+    include Rake::DSL if defined? Rake::DSL
+
+    def install_tasks
+      namespace :iron_hide do
+        # Interface to load some local JSON files to a remote CouchDB server
+        #
+        # Usage:
+        #   bundle exec rake load_rules\['/absolute/path/file.json','http://127.0.0.1:5984/rules'\]
+        #
+        desc 'Load rules from local JSON file to remote CouchDB server'
+        task :load_rules, :file, :db_server do |t, args|
+          db    = args[:db_server]
+          rules = MultiJson.load(File.open(args[:file]).read)
+
+          # Use the bulk document API
+          # See: https://wiki.apache.org/couchdb/HTTP_Bulk_Document_API
+          response = Typhoeus.post("#{db}/_bulk_docs",
+            body: MultiJson.dump(docs: rules), headers: { "Content-Type" => "application/json" })
+
+          puts "Status: #{response.response_code}\nBody: #{response.body}"
+        end
+
+        # Interface to create a CouchDB database if one doesn't exist
+        #
+        # Usage:
+        #   bundle exec rake create_db\['http://127.0.0.1:5984/rules'\]
+        #
+        desc 'Create a database'
+        task :create_db, :db do |t, args|
+          CouchRest.database!(args[:db])
+        end
+
+        # Interface to create required views on CouchDB server.
+        #
+        # Usage:
+        #   bundle exec rake create_views\['http://127.0.0.1:5984/rules'\]
+        #
+        desc 'Create a map-reduce view on a CouchDB server to find rules by namespace and resource'
+        task :create_views, :db_server do |t, args|
+          db       = args[:db_server]
+          function = "function(doc) {" \
+                    "  doc.action.forEach(function(e) {" \
+                    "    if(e && doc.resource){" \
+                    "      emit(doc.resource + '::' + e, doc);" \
+                    "    }" \
+                    "  })" \
+                    "};"
+
+          document = {
+            "_id" => "_design/rules",
+            "views" => {
+              "resource_rules" => {
+                "map" => function
+              }
+            }
+          }
+          response = Typhoeus.post(db,
+            body: MultiJson.dump(document), headers: { "Content-Type" => "application/json"} )
+          puts "Status: #{response.response_code}\nBody: #{response.body}"
+        end
+      end
+    end
+  end
+end
+
+IronHide::CouchDbTasks.new.install_tasks

data/lib/iron_hide/storage/couchdb_adapter.rb

@@ -0,0 +1,64 @@
+require 'multi_json'
+require 'iron_hide'
+require 'iron_hide/storage'
+require 'typhoeus'
+
+module IronHide
+  class Storage
+    class CouchdbAdapter
+
+      # @option opts [String] :resource *required*
+      # @option opts [String] :action *required*
+      # @return [Array<Hash>] array of canonical JSON representation of rules
+      def where(opts = {})
+        self["#{opts.fetch(:resource)}::#{opts.fetch(:action)}"]
+      end
+
+      private
+      # Implements an interface that makes selecting rules look like a Hash:
+      # @example
+      #   {
+      #     'com::test::TestResource::read' => {
+      #       ...
+      #     }
+      #   }
+      #  adapter['com::test::TestResource::read']
+      #  #=> [Array<Hash>]
+      #
+      # @param [Symbol] val
+      # @return [Array<Hash>] array of canonical JSON representation of rules
+      def [](val)
+        response = couchd_db_rules(val)
+        if response.response_code == 200
+          MultiJson.load(response.response_body)["rows"].reduce([]) do |rval, row|
+            rval << row["value"]
+          end
+        else
+          # Do Something
+        end
+      end
+
+      def couchd_db_rules(val)
+        Typhoeus.get(
+          "#{server}/#{database}/_design/rules/_view/resource_rules?key=\"#{val}\""
+        )
+      end
+
+      def server
+        IronHide.configuration.couchdb_server
+      end
+
+      def database
+        IronHide.configuration.couchdb_database
+      end
+
+    end
+  end
+end
+
+# Add adapter class to IronHide::Storage
+IronHide::Storage::ADAPTERS.merge!(couchdb: :CouchdbAdapter)
+
+# Add default configuration variables
+IronHide.configuration.add_configuration(couchdb_server: 'http://127.0.0.1:5984',
+                                         couchdb_database: 'rules')

data/lib/iron_hide/storage/couchdb_adapter/version.rb

@@ -0,0 +1,7 @@
+module IronHide
+  class Storage
+    class CouchdbAdapter
+      VERSION = "0.0.1"
+    end
+  end
+end

metadata

@@ -0,0 +1,151 @@
+--- !ruby/object:Gem::Specification
+name: iron_hide-storage-couchdb_adapter
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Alan Cohen
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-04-15 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1'
+- !ruby/object:Gem::Dependency
+  name: iron_hide
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.14'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.14'
+- !ruby/object:Gem::Dependency
+  name: typhoeus
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.6.8
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.6.8
+- !ruby/object:Gem::Dependency
+  name: multi_json
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: couchrest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.2'
+description: Requires IronHide
+email:
+- acohen@climate.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- iron_hide-storage-couchdb_adapter.gemspec
+- lib/iron_hide/couchdb_tasks.rb
+- lib/iron_hide/storage/couchdb_adapter.rb
+- lib/iron_hide/storage/couchdb_adapter/version.rb
+homepage: ''
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.2.1
+signing_key: 
+specification_version: 4
+summary: A CouchDB adapter for IronHide Authorization
+test_files: []