responsible 0.0.1

checksums.yaml

@@ -0,0 +1,15 @@
+---
+!binary "U0hBMQ==":
+  metadata.gz: !binary |-
+    ODBiZDU4NGFlZmYwZWM4YmY5YmQwNzc5MzBkYmIwYzY0YzE2OGU3Mg==
+  data.tar.gz: !binary |-
+    YjI3MDIxMmY3ZWMwODZiYjM5MjQ1NjI1YWYxZmE1ZTE3OTVkNTUzYw==
+SHA512:
+  metadata.gz: !binary |-
+    MWY5YWFiNGE0ZGU4ZjkzYjEwYmUxNDg2ZDQ3OTY1NWQwMTYyNDU5NjU1YzJk
+    ZWQzYmRjOGRjNjZmMTg4NTIxZTk3YzI2M2JlNzFhMGQyODU4ZGJlY2Q4ZmMz
+    MmNhN2M5N2Y2ZDdiYmI0MzA0M2Y3ZTYwNjcwNTQzZjU2Mjg1NDA=
+  data.tar.gz: !binary |-
+    NzAxNzA4YWM3YTU4YWMyODgwN2JhOTk2MTJiOWZhZTBkNjVjZDM2MzRjMGU5
+    ZGUzNzU0MTA2N2RkZTYxNzUxZjZjNWY3Y2QxYTgwY2UzZWIyZjdlZDdlNDJl
+    OGRkNmEwZTlhMzM5MWZiMDMzMTFmZWRmNzU2M2I3ZDk4NWNlOGI=

data/Gemfile

@@ -0,0 +1,5 @@
+gemspec
+
+group :test do
+  gem "rspec"
+end

data/LICENSE

@@ -0,0 +1,20 @@
+The MIT License (MIT)
+
+Copyright (c) 2014 Reevoo
+
+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,4 @@
+responsible
+===========
+
+Generic Response Builder

data/lib/consumer.rb

@@ -0,0 +1,11 @@
+module Responsible
+  class Consumer
+    def initialize(*valid_restrictions)
+      @valid_restrictions = valid_restrictions
+    end
+
+    def can_see?(restrictions)
+      @valid_restrictions.include?(restrictions)
+    end
+  end
+end

data/lib/responsible.rb

@@ -0,0 +1,66 @@
+module Responsible
+
+  class PropertyNotImplemented < StandardError; end
+  class UnknownConfigurationParameter < StandardError; end
+
+  class Base
+
+    class << self
+      def doc(str=nil)
+        @doc ||= []
+        @doc << str if str
+        @doc
+      end
+
+      def property(name, options={})
+        unknown_configuration_params = options.keys - [:delegate, :to, :restrict_to, :doc]
+        raise(Responsible::UnknownConfigurationParameter, unknown_configuration_params.join(", ")) if unknown_configuration_params.any?
+
+        properties[name.to_sym] = options
+        delegate_method(name, options[:to]) if options[:delegate]
+      end
+
+      def properties
+        @properties ||= {}
+      end
+
+      private
+
+      def delegate_method(name, to)
+        define_method name do
+          data.send(to || name)
+        end
+      end
+    end
+
+    attr_reader :consumer, :data
+
+    def initialize(consumer, data)
+      @consumer, @data = consumer, data
+
+      undefined_properties = _properties_.keys - methods
+
+      if undefined_properties.any?
+        raise Responsible::PropertyNotImplemented, undefined_properties.join(", ")
+      end
+    end
+
+    def as_json(opt={})
+      result = {}
+
+      _properties_.each do |name, options|
+        if consumer.can_see?(options[:restrict_to])
+          result[name] = send(name)
+        end
+      end
+
+      result
+    end
+    
+    private
+
+    def _properties_
+      self.class.properties
+    end
+  end
+end

data/responsible.gemspec

@@ -0,0 +1,19 @@
+$:.unshift 'lib'
+
+Gem::Specification.new do |s|
+  s.platform   = Gem::Platform::RUBY
+  s.name       = "responsible"
+  s.version    = "0.0.1"
+  s.date       = Time.now.strftime('%Y-%m-%d')
+  s.homepage   = "https://github.com/reevoo/responsible"
+  s.authors    = ["dw_henry", "lamp"]
+  s.email      = "developers@reevoo.com"
+  s.summary    = "Response builders"
+
+  s.files      = %w[ Gemfile README.md responsible.gemspec LICENSE ]
+  s.files     += Dir['lib/**/*']
+  s.test_files = Dir['spec/**/*']
+
+  s.add_development_dependency 'rake'
+  s.add_development_dependency 'minitest'
+end

data/spec/base_spec.rb

@@ -0,0 +1,128 @@
+require 'spec_helper'
+
+describe Responsible::Base do
+
+  context "when a simple property is declare" do
+    let(:consumer) { double(:consumer) }
+    let(:data) { double(:data) }
+
+    it "raises an error is the property is not implemented" do
+      klass = Class.new(described_class) do
+        property :not_implemented
+      end
+
+      expect {
+        klass.new(consumer, data)
+      }.to raise_error(Responsible::PropertyNotImplemented)
+    end
+
+    it "defines a property if the method exists" do
+      klass = Class.new(described_class) do
+        property :implemented
+
+        def implemented
+
+        end
+      end
+
+      expect {
+        klass.new(consumer, data)
+      }.to_not raise_error
+    end
+
+    it "will create a delegated method (to the 2nd arg) if delegate: true passed in" do
+      klass = Class.new(described_class) do
+        property :delegated, delegate: true
+      end
+
+      expect {
+        klass.new(consumer, data)
+      }.to_not raise_error
+
+      data = Struct.new(:delegated).new('delegated value')
+      klass.new(consumer, data).delegated.should == 'delegated value'
+    end
+
+    it "raises an error if defined with unknown param" do
+      expect {
+        Class.new(described_class) do
+          property :delegated, unknown_param: true
+        end
+      }.to raise_error(Responsible::UnknownConfigurationParameter)
+    end
+
+    context "when 'to' parameter passed in" do
+      it "raises and error if to method is not defined" do
+        klass = Class.new(described_class) do
+          property :delegated, delegate: true, to: :delegated?
+        end
+
+        data_class = Class.new do
+          def delegated?
+            true
+          end
+        end
+
+        klass.new(consumer, data_class.new).delegated.should be_true
+      end
+    end
+  end
+
+  describe "#as_json" do
+
+    it "returns a data structure that includes properties without a role" do
+      klass = Class.new(described_class) do
+        property :no_role
+
+        def no_role
+          data.no_role
+        end
+      end
+
+      consumer = double(:consumer, can_see?: true)
+      data = double(:data, no_role: true)
+
+      expect(klass.new(consumer, data).as_json).to eq(no_role: true)
+    end
+
+    it "returns a data structure that does not include properties that has a role the consumer can't see" do
+      klass = Class.new(described_class) do
+        property :with_role, restrict_to: :some_role
+
+        def with_role
+          data.with_role
+        end
+      end
+
+      consumer = double(:consumer, can_see?: false)
+      data = double(:data, with_role: 'besty')
+      expect(klass.new(consumer, data).as_json).to eq({})
+    end
+
+    it "returns a data structure that includes properties for multipler roles the consumer can see" do
+      klass = Class.new(described_class) do
+        property :with_external_role,  restrict_to: :external
+        property :with_analytics_role, restrict_to: :analytics
+        property :with_another_role,   restrict_to: :another_role
+
+        def with_external_role
+          data.with_external_role
+        end
+
+        def with_analytics_role
+          data.with_analytics_role
+        end
+
+        def with_another_role
+          data.with_another_role
+        end
+      end
+
+      
+      data = double(:data, with_external_role: 'external', with_analytics_role: 'analytics', with_another_role: 'another')
+      consumer = Responsible::Consumer.new(:external, :analytics)
+
+      expect(klass.new(consumer, data).as_json).to eq( { with_external_role: 'external', with_analytics_role: 'analytics' } )
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,3 @@
+$LOAD_PATH.unshift("./lib")
+require 'responsible'
+require 'consumer'

metadata

@@ -0,0 +1,82 @@
+--- !ruby/object:Gem::Specification
+name: responsible
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- dw_henry
+- lamp
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-02-20 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rake
+  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: minitest
+  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'
+description: 
+email: developers@reevoo.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- Gemfile
+- README.md
+- responsible.gemspec
+- LICENSE
+- lib/consumer.rb
+- lib/responsible.rb
+- spec/base_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/reevoo/responsible
+licenses: []
+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.1.11
+signing_key: 
+specification_version: 4
+summary: Response builders
+test_files:
+- spec/base_spec.rb
+- spec/spec_helper.rb
+has_rdoc: