sorry-rails 0.1.1 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 33f0f6dd7ac550d6064a8f90b428f635128a6ddd
-  data.tar.gz: 1815b8933a345176d80fe341cbaf84aee30eb6b2
+  metadata.gz: 47ef1033ef828a5f626e82e9917e4b933faf134b
+  data.tar.gz: 468b191147aa0fe4f8609b2f3e6d7ed3cd5f5013
 SHA512:
-  metadata.gz: 9e0b92e456690951be39ec8a8099ca0ec3b54bc659531ff8a19433df4fbd505c43fb24b0649d5cfe3925d1c6ff2c796f80abe6c7b78443bc2cb5fe11ff84ee0c
-  data.tar.gz: 4bfa6e41064cc24117d728dc2f49ce7dd145159c5c60df0dbe19bf83bc90bbe8f63ce737c9f96439ec837d5c71d00bfb8161a6ddcc101e4032ef355a987ede33
+  metadata.gz: 493917af41e616934deed8ae63115eda700c7972a1e1f8ee2fca69a67cf087e79aa0ffff669ca3d74ba8f3d44bcde97465e7a909e6d0c9ccabc729d47a648ebe
+  data.tar.gz: f37b3b7e311b7ae90d0d75da0ef90cff99e8d2579369d7d52c40bda59e38ba69a2e51c0bf8891ab1063c11d2cf360c1df4c807679fd6b9e451fe82dff26e6e45

data/.gitignore

@@ -0,0 +1,12 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+.DS_Store
+
+# rspec failure tracking
+.rspec_status

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.rubocop.yml

@@ -0,0 +1,28 @@
+Layout/IndentationWidth:
+  Width: 4
+
+Metrics/LineLength:
+  Max: 200
+
+Metrics/BlockLength:
+  Exclude:
+    - 'spec/**/*.rb'
+
+Layout/EmptyLinesAroundBlockBody:
+  Exclude:
+    - 'spec/**/*.rb'
+
+Layout/EmptyLinesAroundClassBody:
+  EnforcedStyle: empty_lines_except_namespace
+
+Layout/EmptyLinesAroundModuleBody:
+  EnforcedStyle: empty_lines_except_namespace
+
+Layout/AlignParameters:
+  EnforcedStyle: with_fixed_indentation
+
+Layout/IndentHash:
+  EnforcedStyle: consistent
+
+Style/GuardClause:
+  Enabled: false

data/.travis.yml

@@ -0,0 +1,8 @@
+language: ruby
+rvm:
+  - 2.5
+  - 2.4
+  - 2.3
+script:
+  - bundle exec rubocop
+  - bundle exec rake

data/Gemfile

@@ -0,0 +1,6 @@
+source 'https://rubygems.org'
+
+git_source(:github) { |repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in sorry-rails.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,96 @@
+PATH
+  remote: .
+  specs:
+    sorry-rails (0.1.2)
+      actionview
+      activesupport
+      hashie (~> 2.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    actionview (5.2.0)
+      activesupport (= 5.2.0)
+      builder (~> 3.1)
+      erubi (~> 1.4)
+      rails-dom-testing (~> 2.0)
+      rails-html-sanitizer (~> 1.0, >= 1.0.3)
+    activesupport (5.2.0)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      i18n (>= 0.7, < 2)
+      minitest (~> 5.1)
+      tzinfo (~> 1.1)
+    ast (2.4.0)
+    builder (3.2.3)
+    concurrent-ruby (1.0.5)
+    crass (1.0.4)
+    diff-lcs (1.3)
+    erubi (1.7.1)
+    faker (1.8.7)
+      i18n (>= 0.7)
+    hashie (2.1.2)
+    i18n (1.0.1)
+      concurrent-ruby (~> 1.0)
+    jaro_winkler (1.5.1)
+    loofah (2.2.2)
+      crass (~> 1.0.2)
+      nokogiri (>= 1.5.9)
+    mini_portile2 (2.3.0)
+    minitest (5.11.3)
+    nokogiri (1.8.4)
+      mini_portile2 (~> 2.3.0)
+    parallel (1.12.1)
+    parser (2.5.1.2)
+      ast (~> 2.4.0)
+    powerpack (0.1.2)
+    rails-dom-testing (2.0.3)
+      activesupport (>= 4.2.0)
+      nokogiri (>= 1.6)
+    rails-html-sanitizer (1.0.4)
+      loofah (~> 2.2, >= 2.2.2)
+    rainbow (3.0.0)
+    rake (12.3.1)
+    rspec (3.7.0)
+      rspec-core (~> 3.7.0)
+      rspec-expectations (~> 3.7.0)
+      rspec-mocks (~> 3.7.0)
+    rspec-core (3.7.1)
+      rspec-support (~> 3.7.0)
+    rspec-expectations (3.7.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.7.0)
+    rspec-html-matchers (0.9.1)
+      nokogiri (~> 1)
+      rspec (>= 3.0.0.a, < 4)
+    rspec-mocks (3.7.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.7.0)
+    rspec-support (3.7.1)
+    rubocop (0.58.1)
+      jaro_winkler (~> 1.5.1)
+      parallel (~> 1.10)
+      parser (>= 2.5, != 2.5.1.1)
+      powerpack (~> 0.1)
+      rainbow (>= 2.2.2, < 4.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (~> 1.0, >= 1.0.1)
+    ruby-progressbar (1.9.0)
+    thread_safe (0.3.6)
+    tzinfo (1.2.5)
+      thread_safe (~> 0.1)
+    unicode-display_width (1.4.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler
+  faker
+  rake
+  rspec
+  rspec-html-matchers
+  rubocop
+  sorry-rails!
+
+BUNDLED WITH
+   1.16.2

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2018 Robert Rawlins
+
+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,107 @@
+# Sorry™ - Rails
+
+[![Build Status](https://travis-ci.org/sorry-app/sorry-rails.svg?branch=master)](https://travis-ci.org/sorry-app/sorry-rails)
+
+> A Rails gem to add the [Sorry™ Website Plugin](https://github.com/sorry-app/status-bar) to your application. Easily display notices from your status page to your users, and register them as subscribers to receive updates when the particular parts of your application they use are experiencing issues.
+
+## Installation
+
+#### Install the Gem
+
+Add the gem to your Gemfile.
+
+```ruby
+gem 'sorry-rails'
+```
+
+Once this has been done you can run `bundle install` to install the gem into your bundle.
+
+#### Create an Initializer
+
+Create an initializer to configure your plugin, we'd suggest putting this in `/config/initializers/sorry-rails.rb`.
+
+```ruby
+# Configure website plugin.
+Sorry::Rails.configure do |config|
+    # Set the page identity.
+    config.page_id = 'xxxxxxxx'
+end
+```
+
+Place your own status page ID into the initializer, so the plugin knows where to pull your updates from.
+
+#### Include the JavaScript
+
+You can now use the helper method to include the appropriate JavaScript into your layouts and views.
+
+```erb
+<!-- Plugin to install status notices. -->
+<%= sorry_script_tag %>
+```
+
+You'll most likely want to add this to `application.html.erb` so it displays on all pages.
+
+## Subscriber Data
+
+By default the plugin plays nicely with [Devise](https://github.com/plataformatec/devise) by looking for a method called `current_user`, if this method returns an object with an `email` attribute they are passed along as a subscriber, so they'll appear in your subscribers list.
+
+### Custom current user method
+
+If you don't use Devise, or it's default `current_user` method, you can customize the method name in your initializer.
+
+```ruby
+config.current_user_method = :logged_in_user
+```
+
+Pass a symbol which represents the method name, and we'll call that.
+
+### Subscribing to specific components (Established plan only)
+
+Sometimes users don't utilize all of your application, and they'll only want updates about incidents which affect the parts they actually use. For example, if one of our customers uses our Mailgun integration, but Sendgrid is currently experiencing issues, they don't need to know.
+
+You can pass us an array of component_ids that the subscriber is interested in.
+
+```ruby
+# Method name example.
+config.component_ids_method = :component_ids
+
+# Proc based example.
+config.component_ids_method = Proc.new { |user| 
+    # Logic here to get array of IDs...
+}
+```
+
+As per the example, this can either be a method_name to be called on your current_user, or a Proc which is passed the current user, both should return an array of numeric component ids.
+
+## Contributing
+
+In lieu of a formal style-guide, take care to maintain the existing coding style. Add unit tests for any new or changed functionality. Lint and test your code.
+
+Once you are happy that your contribution is ready for production please send us a pull request, at which point we'll review the code and merge it in.
+
+## Versioning
+
+For transparency and insight into our release cycle, and for striving to maintain backward compatibility, This project will be maintained under the Semantic Versioning guidelines as much as possible.
+
+Releases will be numbered with the following format:
+
+`<major>.<minor>.<patch>`
+
+And constructed with the following guidelines:
+
+* Breaking backward compatibility bumps the major (and resets the minor and patch)
+* New additions without breaking backward compatibility bumps the minor (and resets the patch)
+* Bug fixes and misc changes bumps the patch
+
+For more information on SemVer, please visit <http://semver.org/>.
+
+## Authors & Contributors
+
+**Robert Rawlins**
+
++ <http://twitter.com/sirrawlins>
++ <https://github.com/SirRawlins>
+
+## Copyright
+
+&copy; Copyright - See [LICENSE](LICENSE.txt) for details.

data/Rakefile

@@ -0,0 +1,6 @@
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec

data/lib/sorry/rails.rb

@@ -0,0 +1,38 @@
+require 'sorry/rails/configuration'
+require 'sorry/rails/script_tag_helper'
+require 'sorry/rails/subscriber_serializer'
+require 'sorry/rails/railtie' if defined?(::Rails::Railtie)
+require 'sorry/rails/version'
+
+module Sorry
+    #
+    # Mail rails plugin definition for
+    # the Sorry gem.
+    #
+    module Rails
+
+        # Define the JS plugin version to be used
+        # by the script tag generator.
+        PLUGIN_VERSION = '4.latest'.freeze
+
+        class << self
+
+            # Attr to store the configuration.
+            attr_accessor :configuration
+
+            # Allow configuration by block.
+            def configure
+                # Singleton the config instance.
+                self.configuration ||= Configuration.new
+
+                # Yield the config block.
+                yield(configuration)
+
+                # Return the config.
+                self.configuration
+            end
+
+        end
+
+    end
+end

data/lib/sorry/rails/configuration.rb

@@ -0,0 +1,22 @@
+require 'hashie/dash'
+
+module Sorry
+    module Rails
+        #
+        # Configuration class is a glorified hash
+        # for storing settings to be used by the plugin.
+        #
+        class Configuration < Hashie::Dash
+
+            # Define the properties in the config hash.
+            property :page_id
+            # Current user method, defaults to Devise compatible.
+            property :current_user_method, default: :current_user
+
+            # Property accessors for the subscriber.
+            property :email_method, default: :email
+            property :component_ids_method, default: :component_ids
+
+        end
+    end
+end

data/lib/sorry/rails/railtie.rb

@@ -0,0 +1,21 @@
+module Sorry
+    module Rails
+        #
+        # Railtie loads the script tag helper into
+        # action view so we can inject the JS into
+        # the host applications templates.
+        #
+        class Railtie < ::Rails::Railtie
+
+            # On initialization.
+            initializer 'sorry-rails' do
+                # Action view helpers.
+                ActiveSupport.on_load :action_view do
+                    # Include the script tag helper.
+                    include Sorry::Rails::ScriptTagHelper
+                end
+            end
+
+        end
+    end
+end

data/lib/sorry/rails/script_tag_helper.rb

@@ -0,0 +1,64 @@
+require 'active_support/all'
+require 'action_view'
+
+module Sorry
+    module Rails
+        #
+        # An ActionView helper which generates the JavaScript
+        # includes required for the plugin to work.
+        #
+        module ScriptTagHelper
+
+            # Base rails helpers we utilize.
+            include ActionView::Context
+            include ActionView::Helpers::AssetTagHelper
+            include ActionView::Helpers::JavaScriptHelper
+            #
+            # Generate the Sorry Website Plugin script
+            # tag to display status notices to the user
+            # and register them as a subscriber.
+            #
+            def sorry_script_tag(options = {})
+                # Merge configuration in options.
+                options.reverse_merge!(Sorry::Rails.configuration)
+
+                # Include the payload tag and the include
+                # tags for the plugin.
+                safe_join([sorry_script_payload_tag(options), sorry_script_include_tag(options)])
+            end
+
+            def sorry_script_include_tag(options)
+                # Build the JavaScript tag for the plugin include.
+                # Use the latest JS version defined in the plugin.
+                javascript_include_tag "https://code.sorryapp.com/status-bar/#{Sorry::Rails::PLUGIN_VERSION}/status-bar.min.js",
+                    # Define the pages identity.
+                    data: { for: options.fetch('page_id') },
+                    # Load asynchronously.
+                    async: true
+            end
+
+            def sorry_script_payload_tag(options)
+                # Get the method name
+                current_user_method = options.fetch('current_user_method')
+
+                # See if the current user is signed in, so we can
+                # include them as a subscriber.
+                if respond_to?(current_user_method) && send(current_user_method).present?
+                    # Get the current user.
+                    current_request_user = send(current_user_method)
+
+                    # Serialize the user into a subscriber payload.
+                    subscriber_payload = SubscriberSerializer.new(current_request_user).to_json
+
+                    # We have a user method, let's include the JS payload
+                    # object for them as a subscriber.
+                    javascript_tag id: 'sorry-subscriber-data' do
+                        # Include the subscriber payload on the window.
+                        "window.SorryAPIOptions = { \"subscriber\": #{subscriber_payload} };".html_safe
+                    end
+                end
+            end
+
+        end
+    end
+end

data/lib/sorry/rails/subscriber_serializer.rb

@@ -0,0 +1,93 @@
+require 'json'
+
+module Sorry
+    module Rails
+        #
+        # Serializer class takes the applications current_user
+        # and converts it into a safe JSON payload to be included
+        # in the plugin and sent to Sorry as a subscriber.
+        #
+        class SubscriberSerializer
+
+            # Define serializeable fields.
+            SERIALIZEABLE_ATTRIBUTES = %i[email component_ids].freeze
+
+            #
+            # Decorator which receives the current user
+            # model and safely converts them into JSON
+            # for adding to the payload.
+            #
+
+            def initialize(current_user)
+                # Set user instance.
+                @current_user = current_user
+            end
+
+            def to_json(serializeable_attributes = SERIALIZEABLE_ATTRIBUTES)
+                # Check the serializeable attributes are allowed.
+                serializeable_attributes!(serializeable_attributes)
+
+                # Start with an empty attributes hash
+                attributes = {}
+
+                # Loop over the collection or attributes
+                # we can serialize.
+                serializeable_attributes.each do |attribute|
+                    # Add this attribute to the hash.
+                    attributes[attribute] = attribute_value(attribute)
+                end
+
+                # Serialize the collection
+                # remove any attributes not serialized.
+                attributes.compact.to_json
+            end
+
+            #
+            # The value of the attribute can come
+            # from a proc, or from a custom field, or
+            # by looking for a direct attribute on the user.
+            #
+            def attribute_value(attribute)
+                # Get the configured method for the attribute.
+                attribute_method = Sorry::Rails.configuration.fetch("#{attribute}_method")
+
+                # See if the method is a proc.
+                if attribute_method.respond_to?(:call)
+                    # It's a proc, call it with the model.
+                    attribute_method.call(@current_user)
+                # See if the instance responds to it.
+                elsif @current_user.respond_to?(attribute_method)
+                    # It's a method name, invoke
+                    # the method on the model.
+                    @current_user.public_send(attribute_method)
+                end
+            end
+
+            #
+            # Check attributes are serializeable and throw an exception
+            # if they're not included in SERIALIZEABLE_ATTRIBUTES
+            #
+            def serializeable_attributes!(serializeable_attributes)
+                # See if the attributes are serializeable.
+                unless serializeable_attributes?(serializeable_attributes)
+                    # They're not, so throw an error.
+                    raise UnserializableAttributeError, "The attributes (#{(serializeable_attributes - SERIALIZEABLE_ATTRIBUTES)}) are not included in the approved list."
+                end
+            end
+
+            #
+            # Determine if a collection of attribute names
+            # can be serialized or not.
+            #
+            def serializeable_attributes?(serializeable_attributes)
+                # Check that all appear in SERIALIZEABLE_ATTRIBUTES
+                (serializeable_attributes - SERIALIZEABLE_ATTRIBUTES).empty?
+            end
+
+            # Custom error for when someone asks to serialize an
+            # attribute not listed in SERIALIZEABLE_ATTRIBUTES.
+            class UnserializableAttributeError < StandardError; end
+
+        end
+    end
+end

data/lib/sorry/rails/version.rb

@@ -0,0 +1,8 @@
+module Sorry
+    module Rails
+
+        # Define version number on release.
+        VERSION = '0.1.2'.freeze
+
+    end
+end

data/sorry-rails.gemspec

@@ -0,0 +1,28 @@
+lib = File.expand_path('lib', __dir__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'sorry/rails/version'
+
+Gem::Specification.new do |spec|
+    spec.name          = 'sorry-rails'
+    spec.version       = Sorry::Rails::VERSION
+    spec.authors       = ['Robert Rawlins']
+    spec.email         = ['robert@sorryapp.com']
+
+    spec.summary       = 'Add the Sorry™ website plugin to your Rails application.'
+    spec.description   = 'Display status updates from your Sorry™ status page to your users, and affectively customize which notices each user should see.'
+    spec.homepage      = 'https://github.com/sorry-app/sorry-rails'
+    spec.license       = 'MIT'
+
+    spec.files         = `git ls-files`.split($INPUT_RECORD_SEPARATOR)
+
+    spec.add_development_dependency 'bundler'
+    spec.add_development_dependency 'faker'
+    spec.add_development_dependency 'rake'
+    spec.add_development_dependency 'rspec'
+    spec.add_development_dependency 'rspec-html-matchers'
+    spec.add_development_dependency 'rubocop'
+
+    spec.add_dependency 'actionview'
+    spec.add_dependency 'activesupport'
+    spec.add_dependency 'hashie', '~> 2.0'
+end

data/spec/sorry/rails/configuration_spec.rb

@@ -0,0 +1,16 @@
+RSpec.describe Sorry::Rails::Configuration do
+
+    # Get an instance for testing.
+    subject { described_class.new }
+
+    describe '#current_user_method' do
+        # Get the current user method.
+        subject { super().current_user_method }
+
+        context 'by default' do
+            # Check the Devise focussed default.
+            it { is_expected.to eq(:current_user) }
+        end
+    end
+
+end

data/spec/sorry/rails/script_tag_helper_spec.rb

@@ -0,0 +1,72 @@
+RSpec.describe Sorry::Rails::ScriptTagHelper, type: :helper do
+
+    # Include the helper methods for testing.
+    include described_class
+
+    # Mock a page identity to be used.
+    let(:page_id) { Faker::Lorem.characters(8) }
+
+    describe '#sorry_script_tag' do
+        # Get the resulting tag for testing.
+        subject { sorry_script_tag('page_id' => page_id) }
+
+        # Expect string return.
+        it { is_expected.to be_a(String) }
+        it { is_expected.to be_html_safe }
+        it {
+            # Expect an asynchronous JavaScript tag.
+            is_expected.to have_tag('script[async]', with: {
+                # Pointing at the latest version.
+                src: "https://code.sorryapp.com/status-bar/#{Sorry::Rails::PLUGIN_VERSION}/status-bar.min.js",
+                # With the configured page identity.
+                'data-for': page_id
+            })
+        }
+
+        describe 'subscriber_payload' do
+            # The subscribe payload tag id.
+            let(:subscriber_payload_tag) { 'script[id="sorry-subscriber-data"]' }
+
+            context 'without current_user method' do
+                # IT should not include the payload
+                it { is_expected.to_not have_tag(subscriber_payload_tag) }
+            end
+
+            context 'with current_user method' do
+                # Make the configured user method available, and
+                # have it return the mock user.
+                before(:each) do
+                    # Mock the method onto the test class.
+                    allow(self).to receive(Sorry::Rails.configuration.current_user_method).and_return(mock_user)
+                end
+
+                context 'and no user' do
+                    # Mock no user.
+                    let(:mock_user) { nil }
+
+                    # IT should not include the payload
+                    it { is_expected.to_not have_tag(subscriber_payload_tag) }
+                end
+
+                context 'and user is signed in' do
+                    # Mock a user object with an email address
+                    # we can pretend is signed in.
+                    let(:mock_user) { double('User', email: Faker::Internet.email) }
+
+                    # Expect the subscriber payload
+                    it 'contains the expect payload tag' do
+                        # Mock the JSON payload for the user.
+                        subscriber_payload = Sorry::Rails::SubscriberSerializer.new(mock_user).to_json
+
+                        # Check for the script tag.
+                        is_expected.to have_tag(subscriber_payload_tag) do
+                            # Check the serializer JSON payload.
+                            with_text(/window.SorryAPIOptions = { \"subscriber\": #{subscriber_payload} };/)
+                        end
+                    end
+                end
+            end
+        end
+    end
+
+end

data/spec/sorry/rails/subscriber_serializer_spec.rb

@@ -0,0 +1,89 @@
+RSpec.describe Sorry::Rails::SubscriberSerializer do
+
+    # Mock a subscriber / user to serialize
+    # during the tests.
+    let(:current_user) { double('User') }
+
+    describe '#to_json' do
+        # Loop over the attributes to check each.
+        described_class::SERIALIZEABLE_ATTRIBUTES.each do |attribute|
+            # Context for this attribute.
+            context "when serializing #{attribute}" do
+                # Get the JSON hash for testing, only include
+                # a single attribute at a time, easier mocking for tests.
+                subject { described_class.new(current_user).to_json([attribute]) }
+
+                context 'the resulting value' do
+                    # Get the payload result for testing.
+                    subject { JSON.parse(super()).fetch(attribute.to_s) }
+
+                    context 'when customized' do
+                        # Mock the custom method result.
+                        let(:custom_method_result) { Faker::Lorem.sentence }
+
+                        context 'when a customer proc' do
+                            # Stage the user/config for the method.
+                            before(:each) do
+                                # Allow the user to receive the method.
+                                allow(current_user).to receive(:value_through_proc).and_return(custom_method_result)
+
+                                # Mock the method as a Proc.
+                                Sorry::Rails.configuration.send(:"#{attribute}_method=", proc { |user| user.value_through_proc })
+                            end
+
+                            # Expect the custom result.
+                            it { is_expected.to eq(custom_method_result) }
+                        end
+
+                        context 'when a custom method name' do
+                            # Mock a custom method name.
+                            let(:custom_method_name) { Faker::Lorem.word.to_sym }
+
+                            # Stage the user/config for the method.
+                            before(:each) do
+                                # Allow the user to receive the method.
+                                allow(current_user).to receive(custom_method_name).and_return(custom_method_result)
+
+                                # Add the method to the config.
+                                Sorry::Rails.configuration.send(:"#{attribute}_method=", custom_method_name)
+                            end
+
+                            # Expect the custom result.
+                            it { is_expected.to eq(custom_method_result) }
+                        end
+                    end
+
+                    context 'when the default method' do
+                        # Mock the attribute method on the model.
+                        before(:each) { allow(current_user).to receive(attribute).and_return(Faker::Lorem.sentence) }
+
+                        # Is the users own attribute.
+                        it { is_expected.to eq(current_user.send(attribute)) }
+                    end
+
+                    context 'when no matching method on model' do
+                        # Remove the method from the model.
+                        before(:each) { allow(current_user).to receive(:respond_to?).with(attribute).and_return(false) }
+
+                        it 'does not include the attribute' do
+                            # Expect no matching key in the hash.
+                            expect { subject }.to raise_error(KeyError)
+                        end
+                    end
+                end
+            end
+        end
+
+        context 'when passed non-serializeable attribute name' do
+            # Ask for JSON with a random attribute name not
+            # found in the SERIALIZEABLE_ATTRIBUTES constant.
+            subject { described_class.new(current_user).to_json([Faker::Lorem.word]) }
+
+            it 'raises a custom error' do
+                # Expect an error to be thrown.
+                expect { subject }.to raise_error(Sorry::Rails::SubscriberSerializer::UnserializableAttributeError)
+            end
+        end
+    end
+
+end

data/spec/sorry/rails_spec.rb

@@ -0,0 +1,62 @@
+RSpec.describe Sorry::Rails do
+
+    describe '#configure' do
+        # Mock some detailed to pass to the config.
+        let(:page_id) { Faker::Lorem.characters(8) }
+
+        context 'when passed a block' do
+            subject do
+                # Invoke the configure with
+                # a block, setting a mock Page ID.
+                described_class.configure do |config|
+                    # Set the mock page identity.
+                    config.page_id = page_id
+                end
+            end
+
+            # Check a configuration instance records.
+            it { is_expected.to be_a(described_class::Configuration) }
+
+            describe 'the configured page_id' do
+                # Get the page if for testing.
+                subject { super().page_id }
+
+                # Is the one passed in.
+                it { is_expected.to eq(page_id) }
+            end
+        end
+    end
+
+    describe '#configuration' do
+        # Get the configuration for testing.
+        subject { described_class.configuration }
+
+        context 'when previously configured' do
+            # Mock the configuration.
+            let(:configuration) { described_class::Configuration.new }
+
+            # Put the configuration in place.
+            before(:each) { described_class.configuration = configuration }
+
+            # Returns a config class.
+            it { is_expected.to be(configuration) }
+        end
+
+        context 'when not configured' do
+            # Put the configuration in place.
+            before(:each) { described_class.configuration = nil }
+
+            # It has not config.
+            it { is_expected.to be_nil }
+        end
+    end
+
+    describe 'version number' do
+        # Get version for testing.
+        subject { described_class::VERSION }
+
+        # Should be present.
+        it { is_expected.not_to be_nil }
+    end
+
+end

data/spec/spec_helper.rb

@@ -0,0 +1,32 @@
+require 'bundler/setup'
+require 'faker'
+require 'sorry/rails'
+require 'rspec-html-matchers'
+
+RSpec.configure do |config|
+    # Enable flags like --only-failures and --next-failure
+    config.example_status_persistence_file_path = '.rspec_status'
+
+    # Disable RSpec exposing methods globally on `Module` and `main`
+    config.disable_monkey_patching!
+
+    config.expect_with :rspec do |c|
+        # Use more modern syntax.
+        c.syntax = :expect
+    end
+
+    # Reset config singleton after each test.
+    config.around(:each) do |example|
+        # Create a default plugin config.
+        Sorry::Rails.configuration ||= Sorry::Rails::Configuration.new
+
+        # Run the examples.
+        example.run
+
+        # Remove the config.
+        Sorry::Rails.configuration = nil
+    end
+
+    # Include have_tag matchers.
+    config.include RSpecHtmlMatchers
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: sorry-rails
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.2
 platform: ruby
 authors:
 - Robert Rawlins
@@ -143,7 +143,28 @@ email:
 executables: []
 extensions: []
 extra_rdoc_files: []
-files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- ".travis.yml"
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/sorry/rails.rb
+- lib/sorry/rails/configuration.rb
+- lib/sorry/rails/railtie.rb
+- lib/sorry/rails/script_tag_helper.rb
+- lib/sorry/rails/subscriber_serializer.rb
+- lib/sorry/rails/version.rb
+- sorry-rails.gemspec
+- spec/sorry/rails/configuration_spec.rb
+- spec/sorry/rails/script_tag_helper_spec.rb
+- spec/sorry/rails/subscriber_serializer_spec.rb
+- spec/sorry/rails_spec.rb
+- spec/spec_helper.rb
 homepage: https://github.com/sorry-app/sorry-rails
 licenses:
 - MIT