heya 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1aedd0a6d25dc8185eacb59e5e279f6dc6c2135d3980005c1d5b5c82a351c403
-  data.tar.gz: c6007415e758afe5d998ebbe1e9b8ae920e25e4c6abffa9da6c6a9fb1d713ae7
+  metadata.gz: 125b5f898dd3d7841fd0e50ae05d424ec56d2818bb011a43a083f224d15aa3ea
+  data.tar.gz: 23a1fd76278729817ab0317dff81ab816cabd9f09b323e8f723cb5c8f9186eff
 SHA512:
-  metadata.gz: fce537c6eefe599dd9aa3b2be7fdb2c7ce0839c15a7e82256aaf168691103a57ee4e76b146d5cc8d91e7111b546ecbde3041e01e98ff59ac98ef74ce42935fb0
-  data.tar.gz: bceb804f1400eccc44cbacd182007160bbec6b5595613224fff5792596b2661abeeb259bc36e7222bc043cf341754fa8cffb33462828836978fb980b75d5d453
+  metadata.gz: 22b4d72ffa9e69068ce5a77008b76047cf3f1379d330f233b0a4f174a6a89d3a91ab3353e1941b4b1262a4898316cdc1b14e3842468e4fd9bbffa301234c3e62
+  data.tar.gz: bc5c5604c1e1d95adb14fe4435817431c4af2f471a5df7d6bfd4ec100d6a5607cbd4121a31d66660cde7e9a892b84126bf6b6e2d15676afbd36af2fad958910e

data/CHANGELOG.md

@@ -6,6 +6,11 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+## [0.2.0] - 2020-04-14
+### Added
+- Added licensing.
+- Added `rescue_from` (rescuable) in campaigns.
+
 ## [0.1.0] - 2020-03-19
 ### Added
 - Initial release. 👋

data/README.md

@@ -1,30 +1,9 @@
 # Heya 👋
 ![Test](https://github.com/honeybadger-io/heya/workflows/Test/badge.svg)
+[![Gem Version](https://badge.fury.io/rb/heya.svg)](https://badge.fury.io/rb/heya)
 [![Maintainability](https://api.codeclimate.com/v1/badges/a6416e63ffc426715857/maintainability)](https://codeclimate.com/github/honeybadger-io/heya/maintainability)
 
-Heya is a customer communication and automation framework for Ruby on Rails. It's as robust as the hosted alternatives, without the integration and compliance nightmare.
-
-## Why Heya?
-Imagine onboarding and engaging your users with full access to their data, without maintaining a single 3rd-party integration or stressing over compliance. That's Heya: a new way to email your users.
-
-Heya lives inside your Rails app, giving you full access to your customer data with the power of Ruby and Rails for building automated email campaigns.
-
-If you've ever used 3rd-party email or marketing platforms, you've felt the pain of integrating, syncing customer data, and maintaining complex logic and rules--all of which is unnecessary in Heya.
-
-Email automation becomes startlingly simple when your application framework *is* your automation tool.
-
-## Who is Heya for?
-- SaaS developers who are marketers at heart
-- SaaS marketers who are developers at heart
-- Development and marketing teams who work closely together
-
-## Stuff we believe
-- You should avoid duplicating customer data
-- Segments should live as close to home as possible
-  - So should automation
-  - So should content
-- Code is for everyone, not just developers
-- Heya is the best way to engage your users
+Heya is a campaign mailer for Rails. Think of it like ActionMailer, but for timed email sequences. It can also perform other actions like sending a text message.
 
 ## Getting started
 Getting started with Heya is easy:

data/app/mailers/heya/campaign_mailer.rb

@@ -21,5 +21,17 @@ module Heya
         template_name: step.name.underscore
       )
     end
+
+    protected
+
+    def _prefixes
+      @_prefixes_with_campaign_path ||= begin
+        if params.is_a?(Hash) && (campaign_name = params[:step]&.campaign&.name&.underscore)
+          super | ["heya/campaign_mailer/#{campaign_name}"]
+        else
+          super
+        end
+      end
+    end
   end
 end

data/lib/heya.rb

@@ -3,6 +3,7 @@
 require "heya/version"
 require "heya/engine"
 require "heya/config"
+require "heya/license"
 require "heya/campaigns/action"
 require "heya/campaigns/actions/email"
 require "heya/campaigns/actions/block"
@@ -45,4 +46,45 @@ module Heya
     return user.send(segment) if segment.is_a?(Symbol)
     segment.call(user)
   end
+
+  def verify_license!
+    unless File.file?(config.license_file)
+      puts(<<-NOTICE.strip_heredoc)
+        This copy of Heya is licensed for non-commercial non-profit, or 30-day trial usage only.
+        For a commercial use license, please visit https://www.heya.email
+      NOTICE
+      return
+    end
+
+    begin
+      license = License.import(File.read(config.license_file))
+    rescue License::ImportError
+      warn(<<-NOTICE.strip_heredoc)
+        Your Heya license is invalid.
+        If you need support, please visit https://www.heya.email
+      NOTICE
+      return
+    end
+
+    if license.expired?
+      warn(<<-NOTICE.strip_heredoc)
+        Your Heya license has expired.
+        To update your license, please visit https://www.heya.email
+      NOTICE
+      return
+    end
+
+    if (max_user_count = license.restrictions[:user_count]&.to_i)
+      user_count = config.user_type.constantize.count
+      if user_count > max_user_count
+        warn(<<-NOTICE.strip_heredoc)
+          Your app exceeds the number of users for your Heya license.
+          To upgrade your license, please visit https://www.heya.email
+        NOTICE
+      end
+      return # rubocop:disable Style/RedundantReturn
+    end
+
+    # Valid license
+  end
 end

data/lib/heya/campaigns/base.rb

@@ -1,6 +1,7 @@
 # frozen_string_literal: true
 
 require "active_support/descendants_tracker"
+require "active_support/rescuable"
 
 module Heya
   module Campaigns
@@ -11,6 +12,7 @@ module Heya
 
       include Singleton
       include GlobalID::Identification
+      include ActiveSupport::Rescuable
 
       def initialize
         self.steps = []
@@ -27,11 +29,21 @@ module Heya
       def add(user, restart: false, concurrent: false, send_now: true)
         return false unless Heya.in_segments?(user, *__segments)
 
-        restart && CampaignReceipt
-          .where(user: user, step_gid: steps.map(&:gid))
-          .delete_all
+        membership = CampaignMembership.where(user: user, campaign_gid: gid)
+        if membership.exists?
+          return false unless restart
+          membership.delete_all
+        end
+
+        if restart
+          CampaignReceipt
+            .where(user: user, step_gid: steps.map(&:gid))
+            .delete_all
+        end
 
-        CampaignMembership.where(user: user, campaign_gid: gid, concurrent: concurrent).first_or_create!
+        membership.create! do |m|
+          m.concurrent = concurrent
+        end
 
         if send_now && (step = steps.first) && step.wait <= 0
           Scheduler.process(self, step, user)
@@ -61,6 +73,10 @@ module Heya
         @user_class ||= self.class.user_type.constantize
       end
 
+      def handle_exception(exception)
+        rescue_with_handler(exception) || raise(exception)
+      end
+
       attr_accessor :steps
 
       private
@@ -89,11 +105,7 @@ module Heya
           instance
         end
 
-        def handle_exception(exception)
-          raise exception
-        end
-
-        delegate :steps, :add, :remove, :users, :gid, :user_class, to: :instance
+        delegate :steps, :add, :remove, :users, :gid, :user_class, :handle_exception, to: :instance
 
         def default(**params)
           self.__defaults = __defaults.merge(params).freeze

data/lib/heya/config.rb

@@ -6,6 +6,7 @@ module Heya
   class Config < OpenStruct
     def initialize
       super(
+        license_file: nil,
         user_type: "User",
         campaigns: OpenStruct.new(
           priority: [],

data/lib/heya/engine.rb

@@ -15,5 +15,16 @@ module Heya
         require_dependency(c)
       end
     end
+
+    config.after_initialize do
+      license_key = File.expand_path("../../../license_key.pub", __FILE__)
+      License.encryption_key = File.read(license_key) if File.file?(license_key)
+
+      Heya.configure do |config|
+        config.license_file ||= Rails.root.join("config/Heya.heya-license")
+      end
+
+      Heya.verify_license!
+    end
   end
 end

data/lib/heya/license.rb

@@ -0,0 +1,179 @@
+# frozen_string_literal: true
+
+# The MIT License (MIT)
+#
+# Copyright (c) 2015 GitLab B.V.
+#
+# 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.
+
+require "openssl"
+require "date"
+require "json"
+require "base64"
+
+require "heya/license/encryptor"
+require "heya/license/boundary"
+
+module Heya
+  class License
+    class Error < StandardError; end
+    class ImportError < Error; end
+    class ValidationError < Error; end
+
+    class << self
+      attr_reader :encryption_key
+      @encryption_key = nil
+
+      def encryption_key=(key)
+        key = OpenSSL::PKey::RSA.new(key.to_s) unless key&.is_a?(OpenSSL::PKey::RSA)
+        @encryption_key = key
+        @encryptor = nil
+      end
+
+      def encryptor
+        @encryptor ||= Encryptor.new(encryption_key)
+      end
+
+      def import(data)
+        if data.nil?
+          raise ImportError, "No license data."
+        end
+
+        data = Boundary.remove_boundary(data)
+
+        begin
+          license_json = encryptor.decrypt(data)
+        rescue Encryptor::Error
+          raise ImportError, "License data could not be decrypted."
+        end
+
+        begin
+          attributes = JSON.parse(license_json)
+        rescue JSON::ParseError
+          raise ImportError, "License data is invalid JSON."
+        end
+
+        new(attributes)
+      end
+    end
+
+    attr_reader :version
+    attr_accessor :licensee, :starts_at, :expires_at
+    attr_accessor :restrictions
+
+    def initialize(attributes = {})
+      load_attributes(attributes)
+    end
+
+    def valid?
+      return false if !licensee || !licensee.is_a?(Hash) || licensee.length == 0
+      return false if !starts_at || !starts_at.is_a?(Date)
+      return false if expires_at && !expires_at.is_a?(Date)
+      return false if restrictions && !restrictions.is_a?(Hash)
+
+      true
+    end
+
+    def validate!
+      raise ValidationError, "License is invalid" unless valid?
+    end
+
+    def will_expire?
+      expires_at
+    end
+
+    def expired?
+      will_expire? && Date.today >= expires_at
+    end
+
+    def restricted?(key = nil)
+      if key
+        restricted? && restrictions.has_key?(key)
+      else
+        restrictions && restrictions.length >= 1
+      end
+    end
+
+    def attributes
+      hash = {}
+
+      hash["version"] = version
+      hash["licensee"] = licensee
+
+      hash["starts_at"] = starts_at
+      hash["expires_at"] = expires_at if will_expire?
+
+      hash["restrictions"] = restrictions if restricted?
+
+      hash
+    end
+
+    def to_json
+      JSON.dump(attributes)
+    end
+
+    def export(boundary: nil)
+      validate!
+
+      data = self.class.encryptor.encrypt(to_json)
+
+      if boundary
+        data = Boundary.add_boundary(data, boundary)
+      end
+
+      data
+    end
+
+    private
+
+    def load_attributes(attributes)
+      attributes = Hash[attributes.map { |k, v| [k.to_s, v] }]
+
+      version = attributes["version"] || 1
+      unless version && version == 1
+        raise ArgumentError, "Version is too new"
+      end
+
+      @version = version
+
+      @licensee = attributes["licensee"]
+
+      %w[starts_at expires_at].each do |attr|
+        value = attributes[attr]
+        if value.is_a?(String)
+          value = begin
+                    Date.parse(value)
+                  rescue
+                    nil
+                  end
+        end
+
+        next unless value
+
+        send("#{attr}=", value)
+      end
+
+      restrictions = attributes["restrictions"]
+      if restrictions&.is_a?(Hash)
+        restrictions = Hash[restrictions.map { |k, v| [k.to_sym, v] }]
+        @restrictions = restrictions
+      end
+    end
+  end
+end

data/lib/heya/license/boundary.rb

@@ -0,0 +1,64 @@
+# frozen_string_literal: true
+
+# The MIT License (MIT)
+#
+# Copyright (c) 2015 GitLab B.V.
+#
+# 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.
+
+module Heya
+  class License
+    module Boundary
+      BOUNDARY_START = /(\A|\r?\n)-*BEGIN .+? LICENSE-*\r?\n/.freeze
+      BOUNDARY_END = /\r?\n-*END .+? LICENSE-*(\r?\n|\z)/.freeze
+
+      class << self
+        def add_boundary(data, product_name)
+          data = remove_boundary(data)
+
+          product_name.upcase!
+
+          pad = lambda do |message, width|
+            total_padding = [width - message.length, 0].max
+
+            padding = total_padding / 2.0
+            [
+              "-" * padding.ceil,
+              message,
+              "-" * padding.floor
+            ].join
+          end
+
+          [
+            pad.call("BEGIN #{product_name} LICENSE", 60),
+            data.strip,
+            pad.call("END #{product_name} LICENSE", 60)
+          ].join("\n")
+        end
+
+        def remove_boundary(data)
+          after_boundary = data.split(BOUNDARY_START).last
+          in_boundary = after_boundary.split(BOUNDARY_END).first
+
+          in_boundary
+        end
+      end
+    end
+  end
+end

data/lib/heya/license/encryptor.rb

@@ -0,0 +1,122 @@
+# frozen_string_literal: true
+
+# The MIT License (MIT)
+#
+# Copyright (c) 2015 GitLab B.V.
+#
+# 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.
+
+module Heya
+  class License
+    class Encryptor
+      class Error < StandardError; end
+      class KeyError < Error; end
+      class DecryptionError < Error; end
+
+      attr_accessor :key
+
+      def initialize(key)
+        if key && !key.is_a?(OpenSSL::PKey::RSA)
+          raise KeyError, "No RSA encryption key provided."
+        end
+
+        @key = key
+      end
+
+      def encrypt(data)
+        unless key.private?
+          raise KeyError, "Provided key is not a private key."
+        end
+
+        # Encrypt the data using symmetric AES encryption.
+        cipher = OpenSSL::Cipher::AES128.new(:CBC)
+        cipher.encrypt
+        aes_key = cipher.random_key
+        aes_iv = cipher.random_iv
+
+        encrypted_data = cipher.update(data) + cipher.final
+
+        # Encrypt the AES key using asymmetric RSA encryption.
+        encrypted_key = key.private_encrypt(aes_key)
+
+        encryption_data = {
+          "data" => Base64.encode64(encrypted_data),
+          "key" => Base64.encode64(encrypted_key),
+          "iv" => Base64.encode64(aes_iv)
+        }
+
+        json_data = JSON.dump(encryption_data)
+        Base64.encode64(json_data)
+      end
+
+      def decrypt(data)
+        unless key.public?
+          raise KeyError, "Provided key is not a public key."
+        end
+
+        json_data = Base64.decode64(data.chomp)
+
+        begin
+          encryption_data = JSON.parse(json_data)
+        rescue JSON::ParserError
+          raise DecryptionError, "Encryption data is invalid JSON."
+        end
+
+        unless %w[data key iv].all? { |key| encryption_data[key] }
+          raise DecryptionError, "Required field missing from encryption data."
+        end
+
+        encrypted_data = Base64.decode64(encryption_data["data"])
+        encrypted_key = Base64.decode64(encryption_data["key"])
+        aes_iv = Base64.decode64(encryption_data["iv"])
+
+        begin
+          # Decrypt the AES key using asymmetric RSA encryption.
+          aes_key = self.key.public_decrypt(encrypted_key)
+        rescue OpenSSL::PKey::RSAError
+          raise DecryptionError, "AES encryption key could not be decrypted."
+        end
+
+        # Decrypt the data using symmetric AES encryption.
+        cipher = OpenSSL::Cipher::AES128.new(:CBC)
+        cipher.decrypt
+
+        begin
+          cipher.key = aes_key
+        rescue OpenSSL::Cipher::CipherError
+          raise DecryptionError, "AES encryption key is invalid."
+        end
+
+        begin
+          cipher.iv = aes_iv
+        rescue OpenSSL::Cipher::CipherError
+          raise DecryptionError, "AES IV is invalid."
+        end
+
+        begin
+          data = cipher.update(encrypted_data) + cipher.final
+        rescue OpenSSL::Cipher::CipherError
+          raise DecryptionError, "Data could not be decrypted."
+        end
+
+        data
+      end
+    end
+  end
+end

data/lib/heya/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Heya
-  VERSION = "0.1.0"
+  VERSION = "0.2.0"
 end

data/license_key.pub

@@ -0,0 +1,9 @@
+-----BEGIN PUBLIC KEY-----
+MIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEAycgMy1EVcD50WlDhfMDq
+0wvLZb1iF1Hes5IU37QZeswq4qy5MZKBx8669Jy04QH3RnrY0XyO6c1bnr2rnv8M
+NZL8M0ibGpG0NWv0O2tzaVb7706Vm/VuQGR9BuFSe8ZlKRyvMJpk1Kl8NKeRl+iu
+KMN7AK48/b7/stB8P5NVb/8LCOUfIkcOZcTZN9YJvXbyq5i/i2i2IRgxib0zmkU3
+yCOVZnvW0spaH+Z6SuXTZ/wefXM9XRCpshuEvBnS8vihcyQioFkswF2An4FL8B+N
+AWaeA3NcNJEiUFsCpp0uUOVqVZ2avhpATB7fAG4Qh3JauajhWBrqSJYZn2W6uyDp
+fQIDAQAB
+-----END PUBLIC KEY-----

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: heya
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Joshua Wood
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-03-20 00:00:00.000000000 Z
+date: 2020-04-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -108,8 +108,12 @@ files:
 - lib/heya/campaigns/step_action_job.rb
 - lib/heya/config.rb
 - lib/heya/engine.rb
+- lib/heya/license.rb
+- lib/heya/license/boundary.rb
+- lib/heya/license/encryptor.rb
 - lib/heya/version.rb
 - lib/tasks/heya_tasks.rake
+- license_key.pub
 homepage: https://github.com/honeybadger-io/heya
 licenses:
 - Prosperity Public License
@@ -129,7 +133,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
+rubygems_version: 3.1.2
 signing_key: 
 specification_version: 4
 summary: "Heya \U0001F44B"