responsible 0.0.2 → 0.0.3

checksums.yaml

@@ -1,15 +1,7 @@
 ---
-!binary "U0hBMQ==":
-  metadata.gz: !binary |-
-    YjU5Y2IzNzQ3YjY1MzAxMzQ3MzY4OWQyYjgzYTQyZjA0YzdlNGYwMQ==
-  data.tar.gz: !binary |-
-    NDNkMGQ5NjRlMjhlYTM4ODEwNWY4NGRhNzMyM2YzMGQ3OTE4YTFiOQ==
+SHA1:
+  metadata.gz: cb9458a07f1290d5222ff96bf060736d2324b849
+  data.tar.gz: d3675f0d6cac094f51f3b1dde2a3f4348cc3f374
 SHA512:
-  metadata.gz: !binary |-
-    ZWIxMmE3MTRjZmFiNGU5NTdlYzZhZTUwY2VhZWY3NGZhMTQyM2UwYWRlOWQz
-    NzAzMTYzODVhY2M5YmI0MTY0ZmM4OTA2NjE1ZGEwMjc1Mzc0YjY5OTEwNGVj
-    NjYyOGE4OWI0MDEzYzQ4NTc0YTg0NWZjOWY2Y2FlNGU2ZGRhNjc=
-  data.tar.gz: !binary |-
-    OTM3MTljZDdkOWMyMTM0NjU1NmI2Mzg1N2JjOGUyOTY3MjM3Y2YzMjYzMDUw
-    YmRlZjBjMDY3OTViNjMxYzdmODFhYzU0OTQzNzYzMTVjN2I0MTQzNmI2YmM4
-    OTUyMGVhMjc2NDhlY2IwOGFmOTlmNzgwOGM0NjczODFhNzdiNjE=
+  metadata.gz: 9452b791b9165bb2c526659b705ddde6fbcdf1fe68c399bc05af2b2cc2d1b1c7d7c1d5784541b4d69d1dbd693b1c0d7ca121082920fd8e7717cc010543907ee6
+  data.tar.gz: 79235cf791daff1e156f44993df1f770fdc45fec06003f4a1420025caaa3fe7faa25bb5e0b2c41b9765cb5138a60a8f4ecb9a556fabddc673ccc890e4c92e5ba

data/Gemfile

@@ -1,5 +1,3 @@
-gemspec
+source 'https://rubygems.org'
 
-group :test do
-  gem "rspec"
-end
+gemspec

data/README.md

@@ -1,4 +1,130 @@
-responsible
-===========
+# Responsible - A Generic Response Builder
+
+This is a alternative to [ActiveModel::Serializer](https://github.com/rails-api/active_model_serializers).  Why you may ask, well when we first built this we did not know about it, any then when we saw how they it had been implemented we decided it had too much magic.
+
+So doesn't Responsible have a lot of magic I hear you ask. And the answer is yes but the magic is clearly defined, with the user needed to explicity set all input, have a look and see what I mean.
+
+## Responsible Base
+
+This is the main class used for declaring what the generated JSON will look like.
+
+```
+require 'json'
+class MySerializer < Responsible::Base
+  # data_object_name :number
+
+	property :value_1, delegate: true
+  property :value_2
+
+  def value_2
+    # number.other[:value]
+    data.other[:value]
+  end
+end
+
+class Number
+  attr_accessor :other
+
+  def initialize(other)
+    @other = other
+  end
+
+	def value_1
+		'one'
+	end
+end
+
+data = Number.new(value: 'two')
+consumer = Responsible::Consumer.new
+
+MySerializer.new(consumer, data).to_json =>
+
+{
+  value_1: 'one',
+  value_2: 'two'
+}
+```
+
+### Initialization
+
+It is initialized using a consumer (see below) and a data object that the JSON will be generated from.
+
+### data_object_name
+
+#### Pending code merge
+This is a convenience method and allow you to specify an access name for the data object you passed into the initializer (you can also access this object using the ```data``` method)
+
+### property
+
+This is how you add items to the json output.  Items are added in the order they are declared and have a number of options that can be set.
+
+#### delegate
+
+If set to true the property be automatically read from the data object that was passed in.
+
+#### to
+
+This should be used with delegate if for any reason the method on the object does not directly match the name you want to use in the json output
+
+i.e.
+
+```
+property :is_king, delegate: true, to: :is_king?
+```
+
+#### restrict_to
+
+Used in conjunction with the consumer (see below) to determine if the property should be included in the json output at runtime.  This allows a single Responsible builder to be able to output different json data based on a users permissions.
+
+
+## Consumer
+
+```
+require 'json'
+class RestrictedSerializer < Responsible::Base
+  property :always,delegate: true
+  property :two,   delegate: true, restrict_to: [:even, :prime]
+  property :three, delegate: true, restrict_to: :prime
+  property :four,  delegate: true, restrict_to: :even
+end
+
+class Number
+  def always; 'here'; end
+  def two; 2; end
+  def three; 3; end
+  def four; 4; end
+end
+
+number = Number.new
+
+even_consumer = Responsible::Consumer.new(:even)
+RestrictedSerializer.new(even_consumer, number).to_json
+# => {always: 'here', two: 2, four: 4}
+
+prime_consumer = Responsible::Consumer.new(:prime)
+RestrictedSerializer.new(prime_consumer, number).to_json
+# => {always: 'here', two: 2, three: 3}
+
+all_permission_consumer = Responsible::Consumer.new(:prime, :even)
+RestrictedSerializer.new(all_permission_consumer, number).to_json
+# => {always: 'here', two: 2, three: 3, four: 4}
+
+no_permission_consumer = Responsible::Consumer.new
+RestrictedSerializer.new(no_permission_consumer, number).to_json
+# => {always: 'here'}
+```
+
+The consumer object is responsible for handling permissioning within the system. The base consumer object that is supplied with the gem can be initialized with a list of restrictions that the currently user can see, when passed into a Responsible class, this will limit the properties that are output to JSON to those which either:
+
+* have no restrictions
+* Are restricted to one of the values supplied to the consumer object on creation.
+
+### Custom Consumers
+
+Please not that the Consumer class is here as a starting point only and that in a production system we would expect a more complicated set of rules to be required. As such do not limit yourself to the sets of restriction functionality outlined here if it does not meet your usecase
+
+### Release notes:
+
+0.0.3
+Ensure that property is always included when no restrictions are specificed.
 
-Generic Response Builder

data/lib/consumer.rb

@@ -5,7 +5,8 @@ module Responsible
     end
 
     def can_see?(restrictions)
-      @valid_restrictions.include?(restrictions)
+      # always allow field with no restrictions to be seen
+      restrictions.nil? || (Array(@valid_restrictions) & Array(restrictions)).any?
     end
   end
 end

data/lib/responsible.rb

@@ -1,3 +1,5 @@
+require 'consumer'
+
 module Responsible
 
   class PropertyNotImplemented < StandardError; end

data/responsible.gemspec

@@ -3,7 +3,7 @@ $:.unshift 'lib'
 Gem::Specification.new do |s|
   s.platform   = Gem::Platform::RUBY
   s.name       = "responsible"
-  s.version    = "0.0.2"
+  s.version    = "0.0.3"
   s.date       = Time.now.strftime('%Y-%m-%d')
   s.homepage   = "https://github.com/reevoo/responsible"
   s.authors    = ["dw_henry", "lamp"]
@@ -16,4 +16,5 @@ Gem::Specification.new do |s|
 
   s.add_development_dependency 'rake'
   s.add_development_dependency 'minitest'
-end
+  s.add_development_dependency 'rspec'
+end

data/spec/consumer_spec.rb

@@ -0,0 +1,36 @@
+require 'spec_helper'
+
+describe Responsible::Consumer do
+  context '#can_see?' do
+    let(:with_no_restrictions) { described_class.new }
+    let(:with_one_restrictions) { described_class.new(:even) }
+    let(:with_two_restrictions) { described_class.new(:even, :prime) }
+
+  	it "always return true when no restrictions passed in" do
+      expect(with_no_restrictions.can_see?(nil)).to be_true
+      expect(with_one_restrictions.can_see?(nil)).to be_true
+      expect(with_two_restrictions.can_see?(nil)).to be_true
+  	end
+
+    it 'return true if at the restriction is in the valid list' do
+      expect(with_no_restrictions.can_see?(:even)).to be_false
+
+      expect(with_one_restrictions.can_see?(:even)).to be_true
+      expect(with_two_restrictions.can_see?(:even)).to be_true
+    end
+
+    it 'return true if any of the restriction are in the valid list' do
+      expect(with_no_restrictions.can_see?([:even, :prime])).to be_false
+      
+      expect(with_one_restrictions.can_see?([:even, :prime])).to be_true
+      expect(with_two_restrictions.can_see?([:even, :prime])).to be_true
+    end
+
+    it 'return false if none of the restriction are in the valid list' do
+      expect(with_no_restrictions.can_see?(:other)).to be_false
+      
+      expect(with_one_restrictions.can_see?(:other)).to be_false
+      expect(with_two_restrictions.can_see?(:other)).to be_false
+    end
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: responsible
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.3
 platform: ruby
 authors:
 - dw_henry
@@ -9,34 +9,48 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-02-26 00:00:00.000000000 Z
+date: 2014-08-19 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'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  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: 
@@ -46,12 +60,13 @@ extensions: []
 extra_rdoc_files: []
 files:
 - Gemfile
-- README.md
-- responsible.gemspec
 - LICENSE
+- README.md
 - lib/consumer.rb
 - lib/responsible.rb
+- responsible.gemspec
 - spec/base_spec.rb
+- spec/consumer_spec.rb
 - spec/spec_helper.rb
 homepage: https://github.com/reevoo/responsible
 licenses: []
@@ -62,21 +77,21 @@ 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
+rubygems_version: 2.2.0
 signing_key: 
 specification_version: 4
 summary: Response builders
 test_files:
 - spec/base_spec.rb
+- spec/consumer_spec.rb
 - spec/spec_helper.rb
-has_rdoc: