sharing_policy 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: de27986501ee5d4754088513b1271acae1882d91
+  data.tar.gz: 1818d8421a6be74ea124cd06e5c2351b1fb6bb04
+SHA512:
+  metadata.gz: b94c7cd7edcf2522941fbc7df6a51ebf69e68f9fff9178e1ffc87f793a422e19b085b1a5811cadcc2ce0ddd11279149a6829d080d7ec6e5e8185035dfeb89ad0
+  data.tar.gz: 9fed42302c061499ec43173e4053ea49d0ba559b4335a220c5c8b22eb7dd678433e1bef124526ece5c96f9b5b7ce073da88b60f19a8614dd649c11abb03672c6

data/.gitignore

@@ -0,0 +1,14 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 TODO: Write your name
+
+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,31 @@
+# SharingPolicy
+
+TODO: Write a gem description
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'sharing_policy'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install sharing_policy
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Contributing
+
+1. Fork it ( https://github.com/[my-github-username]/sharing_policy/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 a new Pull Request

data/Rakefile

@@ -0,0 +1,2 @@
+require "bundler/gem_tasks"
+

data/lib/sharing_policy/version.rb

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

data/lib/sharing_policy.rb

@@ -0,0 +1,98 @@
+require "sharing_policy/version"
+require "active_support/concern"
+require "active_support/dependencies/autoload"
+
+module SharingPolicy
+
+  extend ActiveSupport::Concern
+
+  included do
+  end
+
+  class << self
+    def policy(policy_holder)
+      require 'json'
+      JSON.parse(policy_holder.policy)
+    end
+  end
+
+  def init_policy(policy_text)
+    require 'json'
+    @policy = JSON.parse(policy_text)
+  end
+end
+
+module ViewingPolicy
+  extend ActiveSupport::Concern
+  include SharingPolicy
+
+  included do
+  end
+
+  def init_policy(policy_text)
+    require 'json'
+    @policy = JSON.parse(policy_text)
+  end
+
+  #tries to authorize user against policy, test against each user group
+  def authorize(user, membership_assert, action_assert)
+    auth_responses = []
+    @policy["cases"].each do |user_group, required_actions|
+      response_of_group = authorize_case(user, user_group, membership_assert, action_assert)
+      auth_responses << response_of_group
+    end
+
+    #responde with highest authorization can give
+    status_codes = auth_responses.map {|response| response[0]}
+
+    auth_responses.reject {|response| response[0] > status_codes.min}
+
+  end
+
+  #authorize user for each group specified in policy
+  #return [STATUS_CODE, MESSAGE, BODY]
+  def authorize_case(user, user_group, membership_assert, action_assert)
+    status_code, message, body = 500, "internal error", []
+
+    if membership_assert.call(user, user_group, self)
+      @group_policy = @policy["cases"][user_group]
+      required_actions = @group_policy["actions"]
+
+      if required_actions.size >= 1
+        required_actions.each { |action| 
+          body << action if !action_assert.call(user, action, self)
+        }
+      end
+
+      if body.empty?
+        status_code, message = 200, "authorized as member of #{user_group}"
+      else
+        status_code = 300
+        message = "actions required"
+      end
+
+    else
+
+      status_code = 400
+      message = "no membership found"
+    end
+
+    [status_code, message, body]
+
+  end
+
+end
+
+module PullingPolicy
+  extend ActiveSupport::Concern
+  include SharingPolicy
+
+
+  def init_policy(policy_text)
+    require 'json'
+    @policy = JSON.parse(policy_text)
+  end
+
+  included do
+  end
+end

data/sharing_policy.gemspec

@@ -0,0 +1,26 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'sharing_policy/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "sharing_policy"
+  spec.version       = SharingPolicy::VERSION
+  spec.authors       = ["Miushock"]
+  spec.email         = ["miushock@gmail.com"]
+  spec.summary       = %q{freelog sharing policy}
+  spec.description   = %q{describe later}
+  spec.homepage      = ""
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.7"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 2.6"
+
+  spec.add_dependency "activesupport", "~> 4.0.0"
+end

data/spec/sharing_policy_spec.rb

@@ -0,0 +1,116 @@
+require "spec_helper"
+require "sharing_policy"
+
+describe ViewingPolicy do
+
+  let(:litters_digest) {Node.new(unhappy)}
+
+  #3 kittens
+  let(:dummy) {User.new("dummy@litter.com")}
+  let(:unhappy) {User.new("unhappy@litter.com")}
+  let(:tom) {User.new("tom@wb.com")}
+
+  #a rabbit and a bird
+  let(:bugs_bunny) {User.new("bbunny@wb.com")}
+  let(:tweety) {User.new("tweety@wb.com")}
+
+  #kitten user group
+  let(:cats) {UserGroup.new(litters_digest, [dummy, unhappy, tom])}
+  let(:litter_executives) {UserGroup.new([dummy, unhappy])}
+
+  let(:node) {Node.new(unhappy)}
+
+  let(:pulling_policy_copyleft) {File.read('./spec/testcase_policy/pulling_policy_copyleft.json')}
+  let(:viewing_policy_ffa) {File.read('./spec/testcase_policy/viewing_policy_ffa.json')}
+  let(:pay_once_policy) {File.read('./spec/testcase_policy/pay_once.json')}
+  let(:cats_only) {File.read('./spec/testcase_policy/cats_only.json')}
+
+  let(:resource_1) {Resource.new(dummy, "1", pulling_policy_copyleft)}
+  let(:presentable_1) {Presentable.new(node, resource_1, viewing_policy_ffa)}
+
+  let(:resource_2) {Resource.new(dummy, "2", pulling_policy_copyleft)}
+  let(:presentable_2) {Presentable.new(node, resource_2, cats_only)}
+
+  let(:pay_once_resource) {Resource.new(dummy, "3" , pulling_policy_copyleft)}
+  let(:pay_once_presentable) {Presentable.new(node, pay_once_resource, pay_once_policy)}
+  
+  #create actions
+  let(:pay_for_resource_3) {Action.new("payment", "3", nil)}
+
+  describe ".viewing_policy" do
+    it "returns an viewing policy instance of given json spec" do
+      #puts SharingPolicy.policy(presentable_1)
+    end
+
+    it "raise parsing exception when failed to read or validate givine json" do
+    end
+  end
+
+  describe "#authorize" do
+    it "return OK status on public viewable resource" do
+      presentable_1.init_policy(viewing_policy_ffa)
+      result = presentable_1.authorize(tom, DummyPredicates.method(:member_of_group?), DummyPredicates.method(:action_conducted?))
+
+      result[0][0].should eql(200)
+    end
+
+    it "return OK status on self visit" do
+      presentable_1.init_policy(viewing_policy_ffa)
+      result = presentable_1.authorize(dummy, DummyPredicates.method(:member_of_group?), DummyPredicates.method(:action_conducted?))
+
+      result[0][0].should eql(200)
+    end
+
+    it "let cats access cats only resource" do
+      presentable_2.init_policy(cats_only)
+      result = presentable_2.authorize(unhappy, DummyPredicates.method(:member_of_group?), DummyPredicates.method(:action_conducted?))
+
+      result[0][0].should eql(200)
+    end
+
+    it "reject public from accessing cats resource" do
+      presentable_2.init_policy(cats_only)
+      result = presentable_2.authorize(bugs_bunny, DummyPredicates.method(:member_of_group?), DummyPredicates.method(:action_conducted?))
+
+      result[0][0].should eql(400)
+    end
+
+    it "accept/reject payed/unpayed user from accessing pay_once_resource" do
+      unhappy.take_action(pay_for_resource_3)
+      
+      pay_once_presentable.init_policy(pay_once_policy)
+      paid_result = pay_once_presentable.authorize(unhappy,  DummyPredicates.method(:member_of_group?), DummyPredicates.method(:action_conducted?))
+      unpaid_result = pay_once_presentable.authorize(bugs_bunny,  DummyPredicates.method(:member_of_group?), DummyPredicates.method(:action_conducted?))
+      
+      
+      
+      paid_result[0][0].should eql(200)
+      unpaid_result[0][0].should eql(300)
+    end
+
+    it "reject strangers from cats only resources" do
+    end
+  end
+
+end
+
+describe PullingPolicy do
+  let(:user) {double}
+  let(:node) {Node.new(user)}
+
+  let(:pulling_policy_copyleft) {File.read('./spec/testcase_policy/pulling_policy_copyleft.json')}
+  let(:viewing_policy_ffa) {File.read('./spec/testcase_policy/viewing_policy_ffa.json')}
+
+
+  let(:resource_1) {Resource.new(user, "123", pulling_policy_copyleft)}
+  let(:presentable_1) {Presentable.new(node, resource_1, viewing_policy_ffa)} 
+
+  describe ".pulling_policy" do
+    it "returns an pulling policy instance when given json spec" do
+#      puts SharingPolicy.policy(resource_1)
+    end
+
+    it "raise parsing exception when failed to read or validate givine json" do
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,92 @@
+require "active_support/core_ext/kernel"
+
+warning = capture(:stderr) do
+  require "sharing_policy"
+end
+
+class User
+
+  attr_accessor :id
+
+  def initialize (id)
+    @id = id
+    @action_list = []
+  end
+
+  def actions
+    @action_list
+  end
+
+  def take_action(action)
+    @action_list << action
+  end
+end
+
+class Node < Struct.new(:owner)
+end
+
+class Presentable < Struct.new(:node, :resource, :policy)
+  include ViewingPolicy
+
+  def owner
+    resource.owner
+  end
+
+  def resource_id
+    resource.resource_id
+  end
+end
+
+class Resource < Struct.new(:owner, :resource_id, :policy)
+  include PullingPolicy
+end
+
+class UserGroup < Struct.new(:owner, :roster)
+end
+
+class Action
+  attr_accessor :type, :resource_id, :content
+  def initialize(type, resource_id, content)
+    @type, @resource_id, @content  = type, resource_id, content
+  end
+
+  def eql?(other_action)
+    (@type.eql? other_action.type) && (@resource_id.eql? other_action.resource_id)
+  end
+  attr_accessor :type
+end
+
+module DummyPredicates
+  def self.member_of_group? (user, user_group, resource=nil)
+
+    case user_group
+    when "public"
+      return true
+    when "self"
+      return (resource.nil? ? false : resource.owner == user)
+    when "cats"
+      case user.id
+      when "dummy@litter.com"
+        return true
+      when "unhappy@litter.com"
+        return true
+      when "tom@wb.com"
+        return true
+      else
+        return false
+      end
+    else
+      return false
+    end
+  end
+
+  def self.action_conducted? (user, requirement, resource)
+    action = Action.new(requirement[0], resource.resource_id, nil)
+    action_record_list = user.actions
+    result = action_record_list.select do |record|
+      record.eql? action
+    end
+
+    return result.size > 0
+  end
+end

data/spec/testcase_policy/cats_only.json

@@ -0,0 +1,7 @@
+{
+  "type": "viewing",
+  "cases": {
+    "self" : {"actions":{}},
+    "cats": {"actions":{}}
+  }
+}

data/spec/testcase_policy/pay_once.json

@@ -0,0 +1,11 @@
+{
+  "type": "viewing",
+  "cases": {
+    "self" : {"actions":{}},
+    "public": {"actions":
+      {
+        "payment":50
+      }
+    }
+  }
+}

data/spec/testcase_policy/pulling_policy_copyleft.json

@@ -0,0 +1,11 @@
+{
+  "type": "pulling",
+  "cases": {
+    "self": {},
+    "public": {
+      "actions":{
+        "agreement": "GPL"
+      }
+    }
+  }
+}

data/spec/testcase_policy/viewing_policy_ffa.json

@@ -0,0 +1,7 @@
+{
+  "type": "viewing",
+  "cases": {
+    "self": {"actions":{}},
+    "public": {"actions":{}} 
+  }
+}

metadata

@@ -0,0 +1,120 @@
+--- !ruby/object:Gem::Specification
+name: sharing_policy
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Miushock
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-01-01 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.6'
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 4.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 4.0.0
+description: describe later
+email:
+- miushock@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/sharing_policy.rb
+- lib/sharing_policy/version.rb
+- sharing_policy.gemspec
+- spec/sharing_policy_spec.rb
+- spec/spec_helper.rb
+- spec/testcase_policy/cats_only.json
+- spec/testcase_policy/pay_once.json
+- spec/testcase_policy/pulling_policy_copyleft.json
+- spec/testcase_policy/viewing_policy_ffa.json
+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.4.2
+signing_key: 
+specification_version: 4
+summary: freelog sharing policy
+test_files:
+- spec/sharing_policy_spec.rb
+- spec/spec_helper.rb
+- spec/testcase_policy/cats_only.json
+- spec/testcase_policy/pay_once.json
+- spec/testcase_policy/pulling_policy_copyleft.json
+- spec/testcase_policy/viewing_policy_ffa.json