peach-ruby 0.1.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e6bbf4a34a9d69b838e5a2a0e5562ad0f598ceae6521c5a0738d8966afdebba2
-  data.tar.gz: 5a789324350150dd3a0dfd1e9ad04655fbcd87701f365d4d51998ee40a5cb370
+  metadata.gz: 8a7f27b5b01c8b9ea55f876a6250f0c88eb475f5b420357a286a89cf8fa9482e
+  data.tar.gz: 59347383246e9ba8820d31fc97eed2f1a41c58fda460c540e00ea91d9a2fd5b6
 SHA512:
-  metadata.gz: 49263d5ee3c1089f55ee635afcb843a7779db1c3d1ad024f902018474143b3ea1d68cf3caf8ae72f9db6455463432cae8729e330eb699e4e9f7da783c78c1eaa
-  data.tar.gz: 9732144b1e654ae41a4f886ae08841d5bb97a37ccd2dba69664258722340b6c45651278f57d79888630a844a5827dff6ac87b7a59b8b0829082677b5fffbfbd0
+  metadata.gz: 7f82051293a16fdd61f4bc0b8d034e92eaed01f44fb0aa7dcaabc36db8f17b8e8af0c7c55092efe08fe24db6e1c3d9a3ed1ee9d85da7bdce31afdafcc5c0cbb5
+  data.tar.gz: b416cdc3ae802d1466a612e41f806407fe89597c3c113ca46b558e151abed10fce3eaaee7edf0f225cea8d59eef91b85a02722997f8fd3335b33f0b749f41b9a

data/README.md

@@ -4,21 +4,21 @@ Ruby library for Peach API
 
 ## Installation
 
-TODO: Replace `UPDATE_WITH_YOUR_GEM_NAME_IMMEDIATELY_AFTER_RELEASE_TO_RUBYGEMS_ORG` with your gem name right after releasing it to RubyGems.org. Please do not do it earlier due to security reasons. Alternatively, replace this section with instructions to install your gem from git if you don't plan to release to RubyGems.org.
-
 Install the gem and add to the application's Gemfile by executing:
 
-    $ bundle add UPDATE_WITH_YOUR_GEM_NAME_IMMEDIATELY_AFTER_RELEASE_TO_RUBYGEMS_ORG
+    $ bundle add peach-ruby
 
 If bundler is not being used to manage dependencies, install the gem by executing:
 
-    $ gem install UPDATE_WITH_YOUR_GEM_NAME_IMMEDIATELY_AFTER_RELEASE_TO_RUBYGEMS_ORG
+    $ gem install peach-ruby
 
 ## Usage
 
 Configure the SDK with your API Token:
 
 ```ruby
+require 'peach-ruby'
+
 Peach.configure do |config|
   config.api_token = '<YOUR API TOKEN>'
 end
@@ -27,6 +27,8 @@ end
 And then use it:
 
 ```ruby
+require 'peach-ruby'
+
 contact = {
   id: 1,
   name: 'John Doe',

data/lib/peach/stream/request.rb

@@ -3,11 +3,12 @@
 module Peach
   module Stream
     class Request # :nodoc:
-      attr_reader :params, :context, :contact, :prompt
+      attr_reader :contact, :params, :prompt, :message, :payload, :context
 
       STREAM_TYPES = {
         init: 'stream.init',
-        in_progress: 'stream.in_progress'
+        in_progress: 'stream.in_progress',
+        event_received: 'stream.event_received'
       }.freeze
 
       def initialize(raw_params)
@@ -24,6 +25,10 @@ module Peach
         @type == STREAM_TYPES[:in_progress]
       end
 
+      def event_received?
+        @type == STREAM_TYPES[:event_received]
+      end
+
       private
 
       def parse_params(raw_params)
@@ -45,10 +50,12 @@ module Peach
 
       def instantiate_instance_variables_from(params)
         @type = params[:type]
-        @params = params.dig(:request, :params) || {}
-        @context = params.dig(:request, :context) || {}
         @contact = OpenStruct.new(params.dig(:request, :contact) || {})
+        @params = params.dig(:request, :params) || {}
         @prompt = params.dig(:request, :prompt)
+        @message = OpenStruct.new(params.dig(:request, :message) || {})
+        @payload = params.dig(:request, :payload) || {}
+        @context = params.dig(:request, :context) || {}
       end
 
       def deep_symbolize_keys(hash)

data/lib/peach/stream/response.rb

@@ -1,5 +1,7 @@
 # frozen_string_literal: true
 
+require 'uri'
+
 module Peach
   module Stream
     class Response # :nodoc:
@@ -24,21 +26,43 @@ module Peach
 
       private
 
-      def send_message(text, header_media: {})
+      def send_message(text, media_url: nil)
         message = { text: text }
-        message[:header_media] = header_media unless header_media.empty?
+        message[:media_url] = media_url if media_url
         validate_message(message)
         { message: message }
       end
 
-      def send_prompt(key, data: {}, options: [])
+      def send_prompt(key, data: {}, button: nil, options: [])
         prompt = { key: key }
         prompt[:data] = data unless data.empty?
+        prompt[:button] = button unless button.nil?
         prompt[:options] = options unless options.empty?
         validate_prompt(prompt)
         { prompt: prompt }
       end
 
+      def handoff(user_id: nil, group_id: nil, text: nil)
+        handoff = {}
+        handoff[:message] = { text: text } if text
+        handoff[:user_id] = user_id if user_id
+        handoff[:group_id] = group_id if group_id
+        validate_handoff(handoff)
+        if handoff.empty?
+          {}
+        else
+          { handoff: handoff }
+        end
+      end
+
+      def opt_out
+        {}
+      end
+
+      def opt_in
+        {}
+      end
+
       def add_context(data)
         validate_context data
         { context: data }
@@ -51,54 +75,128 @@ module Peach
       def validate_message(message)
         raise Peach::BadResponseError, 'Field `message` does not have a `text`' if (message[:text] || '').empty?
 
-        return unless message.key?(:header_media)
+        return unless message.key?(:media_url)
 
-        if !message[:header_media].is_a?(Hash)
+        unless message[:media_url].is_a?(String)
           raise Peach::BadResponseError,
-                'Field `message.header_media` is not a Hash'
-        else
-          raise Peach::BadResponseError, 'Field `message.header_media` does not have a `type`' if message.dig(
-            :header_media, :type
-          ).nil?
-
-          type = message.dig(:header_media, :type)
-          if message.dig(:header_media, type,
-                         :url).nil?
-            raise Peach::BadResponseError,
-                  "Field `message.header_media` does not have a `#{type}.url`"
-          end
+                'Field `message.media_url` is not a String'
+        end
+        if message[:media_url].empty?
+          raise Peach::BadResponseError,
+                'Field `message.media_url` is empty'
+        end
+        begin
+          URI.parse(message[:media_url])
+        rescue URI::InvalidURIError
+          raise Peach::BadResponseError, 'Field `message.media_url` is not a valid URL'
         end
       end
 
       def validate_prompt(prompt)
+        validate_key(prompt)
+        validate_data(prompt)
+        validate_button(prompt) if prompt.key?(:button)
+        validate_options(prompt) if prompt.key?(:options)
+      end
+
+      def validate_key(prompt)
         raise Peach::BadResponseError, 'Field `prompt` does not have a `key`' if (prompt[:key] || '').empty?
+      end
 
-        if prompt.key?(:data) && !prompt[:data].is_a?(Hash)
-          raise Peach::BadResponseError,
-                'Field `prompt.data` is not a Hash'
+      def validate_data(prompt)
+        return if !prompt.key?(:data) || prompt[:data].is_a?(Hash)
+
+        raise Peach::BadResponseError, 'Field `prompt.data` is not a Hash'
+      end
+
+      def validate_button(prompt)
+        raise Peach::BadResponseError, 'Field `prompt.button` is not a String' unless prompt[:button].is_a?(String)
+        raise Peach::BadResponseError, 'Field `prompt.button` is empty' if prompt[:button].empty?
+      end
+
+      def validate_options(prompt)
+        raise Peach::BadResponseError, 'Field `prompt.options` is not an Array' unless prompt[:options].is_a?(Array)
+
+        validate_each_option(prompt)
+      end
+
+      def validate_each_option(prompt)
+        prompt[:options].each_with_index do |option, idx|
+          validate_option_is_hash(option, idx)
+          validate_option_title(option, idx)
+          validate_option_value_or_values(prompt, option, idx)
         end
+      end
 
-        return unless prompt.key?(:options)
+      def validate_option_is_hash(option, idx)
+        return if option.is_a?(Hash)
 
-        if !prompt[:options].is_a?(Array)
-          raise Peach::BadResponseError,
-                'Field `prompt.options` is not an Array'
+        raise Peach::BadResponseError, "Field `prompt.options[#{idx}]` '#{option}' is not a Hash"
+      end
+
+      def validate_option_title(option, idx)
+        return if option.key?(:title) && !option[:title].empty?
+
+        raise Peach::BadResponseError, "Field `prompt.options[#{idx}]` '#{option}' does not have a `title`"
+      end
+
+      def validate_option_value_or_values(prompt, option, idx)
+        if prompt.key?(:button)
+          validate_option_values(option, idx)
         else
-          prompt[:options].each do |option|
-            unless option.is_a?(Hash)
-              raise Peach::BadResponseError,
-                    "Field `prompt.options`'s item #{option} is not a Hash"
-            end
-            if (option[:title] || '').empty?
-              raise Peach::BadResponseError,
-                    "Field `prompt.options`'s item #{option} does not have a `title`"
-            end
-            if (option[:value] || '').empty?
-              raise Peach::BadResponseError,
-                    "Field `prompt.options`'s item #{option} does not have a `value`"
-            end
-          end
+          validate_option_value(option, idx)
+        end
+      end
+
+      def validate_option_value(option, idx)
+        return if option.key?(:value) && !option[:value].empty?
+
+        raise Peach::BadResponseError, "Field `prompt.options[#{idx}]` '#{option}' does not have a `value`"
+      end
+
+      def validate_option_values(option, idx)
+        unless option.key?(:values)
+          raise Peach::BadResponseError, "Field `prompt.options[#{idx}] does not have `values`"
+        end
+
+        validate_values_are_array(option, idx)
+        validate_each_value(option, idx)
+      end
+
+      def validate_values_are_array(option, idx)
+        unless option[:values].is_a?(Array)
+          raise Peach::BadResponseError, "Field `prompt.options[#{idx}].values` '#{option}' is not an Array"
         end
+        return unless option[:values].empty?
+
+        raise Peach::BadResponseError, "Field `prompt.options[#{idx}].values` '#{option}' is empty"
+      end
+
+      def validate_each_value(option, idx)
+        option[:values].each_with_index do |item, item_idx|
+          validate_value_title(item, idx, item_idx)
+          validate_value_value(item, idx, item_idx)
+        end
+      end
+
+      def validate_value_title(item, idx, item_idx)
+        return if item.key?(:title) && !item[:title].empty?
+
+        raise Peach::BadResponseError,
+              "Field `prompt.options[#{idx}].values[#{item_idx}]`' '#{item}' does not have a `title`"
+      end
+
+      def validate_value_value(item, idx, item_idx)
+        return if item.key?(:value) && !item[:value].empty?
+
+        raise Peach::BadResponseError,
+              "Field `prompt.options[#{idx}].values[#{item_idx}]` '#{item}' does not have a `value`"
+      end
+
+      def validate_handoff(handoff)
+        return unless handoff.key?(:user_id) && handoff.key?(:group_id)
+
+        raise Peach::BadResponseError, 'Field `handoff` has both `user_id` and `group_id`'
       end
 
       def validate_context(context)

data/lib/peach/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Peach
-  VERSION = '0.1.0'
+  VERSION = '0.3.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: peach-ruby
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.3.0
 platform: ruby
 authors:
 - Peach Developers
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2024-05-02 00:00:00.000000000 Z
+date: 2024-05-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: debug