meta-messenger 2.1.2

data/lib/facebook/messenger/profile.rb

@@ -0,0 +1,92 @@
+require 'httparty'
+
+module Facebook
+  module Messenger
+    #
+    # This module provide functionality to manage the messenger profile.
+    # @see https://developers.facebook.com/docs/messenger-platform/messenger-profile
+    #
+    module Profile
+      include HTTParty
+
+      # Define base_uri for HTTParty.
+      base_uri 'https://graph.facebook.com/v20.0/me'
+
+      format :json
+
+      module_function
+
+      #
+      # Set the messenger profile.
+      #
+      # @raise [Facebook::Messenger::Profile::Error] if there is any error
+      #   in response.
+      #
+      # @param [Hash] settings Hash defining the profile settings.
+      # @param [String] access_token  Access token of facebook page.
+      #
+      # @return [Boolean] If profile is successfully set, return true.
+      #
+      def set(settings, access_token:)
+        response = post '/messenger_profile', body: settings.to_json, query: {
+          access_token: access_token
+        }
+
+        raise_errors(response)
+
+        true
+      end
+
+      #
+      # Unset the messenger profile.
+      #
+      # @raise [Facebook::Messenger::Profile::Error] if there is any error
+      #   in response.
+      #
+      # @param [Hash] settings Hash defining the profile settings.
+      # @param [String] access_token  Access token of facebook page.
+      #
+      # @return [Boolean] If profile is successfully removed, return true.
+      #
+      def unset(settings, access_token:)
+        response = delete '/messenger_profile', body: settings.to_json, query: {
+          access_token: access_token
+        }
+
+        raise_errors(response)
+
+        true
+      end
+
+      #
+      # Function raise error if response has error key.
+      #
+      # @raise [Facebook::Messenger::Profile::Error] if error is present
+      #   in response.
+      #
+      # @param [Hash] response Response hash from facebook.
+      #
+      def raise_errors(response)
+        raise Error, response['error'] if response.key? 'error'
+      end
+
+      #
+      # Default HTTParty options.
+      #
+      # @return [Hash] Default HTTParty options.
+      #
+      def default_options
+        super.merge(
+          headers: {
+            'Content-Type' => 'application/json'
+          }
+        )
+      end
+
+      #
+      # Class Error provides errors related to profile subscriptions.
+      #
+      class Error < Facebook::Messenger::FacebookError; end
+    end
+  end
+end

data/lib/facebook/messenger/server.rb

@@ -0,0 +1,195 @@
+require 'rack'
+require 'json'
+require 'openssl'
+
+module Facebook
+  module Messenger
+    class BadRequestError < Error; end
+
+    X_HUB_SIGNATURE_MISSING_WARNING = <<-HEREDOC.freeze
+      The X-Hub-Signature header is not present in the request. This is
+      expected for the first webhook requests. If it continues after
+      some time, check your app's secret token.
+    HEREDOC
+
+    #
+    # This module holds the server that processes incoming messages from the
+    # Facebook Messenger Platform.
+    #
+    class Server
+      def self.call(env)
+        new.call(env)
+      end
+
+      # Rack handler for request.
+      def call(env)
+        @request = Rack::Request.new(env)
+        @response = Rack::Response.new
+
+        if @request.get?
+          verify
+        elsif @request.post?
+          receive
+        else
+          @response.status = 405
+        end
+
+        @response.finish
+      end
+
+      # @private
+      private
+
+      #
+      # Function validates the verification request which is sent by Facebook
+      #   to validate the entered endpoint.
+      # @see https://developers.facebook.com/docs/graph-api/webhooks#callback
+      #
+      def verify
+        if valid_verify_token?(@request.params['hub.verify_token'])
+          @response.write @request.params['hub.challenge']
+        else
+          @response.write 'Error; wrong verify token'
+        end
+      end
+
+      #
+      # Function handles the webhook events.
+      # @raise BadRequestError if the request is tampered.
+      #
+      def receive
+        check_integrity
+
+        trigger(parsed_body)
+      rescue BadRequestError => error
+        respond_with_error(error)
+      end
+
+      #
+      # Check the integrity of the request.
+      # @see https://developers.facebook.com/docs/messenger-platform/webhook#security
+      #
+      # @raise BadRequestError if the request has been tampered with.
+      #
+      def check_integrity
+        # If app secret is not found in environment, return.
+        # So for the security purpose always add provision in
+        #   configuration provider to return app secret.
+        return unless app_secret_for(parsed_body['entry'][0]['id'])
+
+        unless signature.start_with?('sha1='.freeze)
+          warn X_HUB_SIGNATURE_MISSING_WARNING
+
+          raise BadRequestError, 'Error getting integrity signature'.freeze
+        end
+
+        raise BadRequestError, 'Error checking message integrity'.freeze \
+          unless valid_signature?
+      end
+
+      # Returns a String describing the X-Hub-Signature header.
+      def signature
+        @request.env['HTTP_X_HUB_SIGNATURE'.freeze].to_s
+      end
+
+      #
+      # Verify that the signature given in the X-Hub-Signature header matches
+      # that of the body.
+      #
+      # @return [Boolean] true if request is valid else false.
+      #
+      def valid_signature?
+        Rack::Utils.secure_compare(signature, signature_for(body))
+      end
+
+      #
+      # Sign the given string.
+      #
+      # @return [String] A string describing its signature.
+      #
+      def signature_for(string)
+        format('sha1=%<string>s'.freeze, string: generate_hmac(string))
+      end
+
+      # Generate a HMAC signature for the given content.
+      def generate_hmac(content)
+        content_json = JSON.parse(content, symbolize_names: true)
+        facebook_page_id = content_json[:entry][0][:id]
+
+        OpenSSL::HMAC.hexdigest('sha1'.freeze,
+                                app_secret_for(facebook_page_id),
+                                content)
+      end
+
+      # Returns a String describing the bot's configured app secret.
+      def app_secret_for(facebook_page_id)
+        Facebook::Messenger.config.provider.app_secret_for(facebook_page_id)
+      end
+
+      # Checks whether a verify token is valid.
+      def valid_verify_token?(token)
+        Facebook::Messenger.config.provider.valid_verify_token?(token)
+      end
+
+      # Returns a String describing the request body.
+      def body
+        @body ||= @request.body.read
+      end
+
+      #
+      # Returns a Hash describing the parsed request body.
+      # @raise JSON::ParserError if body hash is not valid.
+      #
+      # @return [JSON] Parsed body hash.
+      #
+      def parsed_body
+        @parsed_body ||= JSON.parse(body)
+      rescue JSON::ParserError => error
+        raise BadRequestError, error
+      end
+
+      #
+      # Function hand over the webhook event to handlers.
+      #
+      # @param [Hash] events Parsed body hash in webhook event.
+      #
+      def trigger(events)
+        # Facebook may batch several items in the 'entry' array during
+        # periods of high load.
+        events['entry'.freeze].each do |entry|
+
+          # Facebook may batch several items in the 'messaging' array during
+          # periods of high load.
+          if entry['messaging'.freeze]
+            entry['messaging'.freeze].each do |messaging|
+              Facebook::Messenger::Bot.receive(messaging)
+            end
+          end
+          if entry['changes'.freeze]
+            entry['changes'.freeze].each do |change|
+              Facebook::Messenger::Bot.receive(change)
+            end
+          end
+          # d99d
+          if entry['standby'.freeze]
+            entry['standby'.freeze].each do |messaging|
+              Facebook::Messenger::Bot.receive(messaging)
+            end
+          end
+          # .
+        end
+      end
+
+      #
+      # If received request is tampered, sent 400 code in response.
+      #
+      # @param [Object] error Error object.
+      #
+      def respond_with_error(error)
+        @response.status = 400
+        @response.write(error.message)
+        @response.headers['Content-Type'.freeze] = 'text/plain'.freeze
+      end
+    end
+  end
+end

data/lib/facebook/messenger/server_no_error.rb

@@ -0,0 +1,36 @@
+require_relative 'server'
+
+module Facebook
+  module Messenger
+    # Server rescuing all errors sending the backtrace back to the chat
+    # FOR DEVELOPPING PURPOSE
+    class ServerNoError < Server
+      SCREAMING_FACE = "\xF0\x9F\x98\xB1".freeze
+      MAX_MESSAGE_LENGTH = 639
+
+      def call(env)
+        super
+      rescue Exception => e # rubocop:disable Lint/RescueException
+        send(SCREAMING_FACE)
+        send(e.inspect)
+        send(e.backtrace.join("\n")[0..MAX_MESSAGE_LENGTH - 3] + '...')
+
+        @response.status = 200
+        @response.finish
+      end
+
+      private
+
+      def sender
+        parsed_body['entry'][0]['messaging'][0]['sender']
+      end
+
+      def send(text)
+        Bot.deliver({
+                      recipient: sender,
+                      message: { text: text }
+                    }, access_token: ENV['ACCESS_TOKEN'])
+      end
+    end
+  end
+end

data/lib/facebook/messenger/subscriptions.rb

@@ -0,0 +1,85 @@
+require 'httparty'
+
+module Facebook
+  module Messenger
+    #
+    # Module Subscriptions handles subscribing and unsubscribing Applications
+    #   to Pages.
+    #
+    module Subscriptions
+      include HTTParty
+
+      base_uri 'https://graph.facebook.com/v20.0/me'
+
+      format :json
+
+      module_function
+
+      #
+      # Function subscribe the facebook app to page.
+      # @see https://developers.facebook.com/docs/graph-api/reference/page/subscribed_apps
+      #
+      # @raise [Facebook::Messenger::Subscriptions::Error] if there is any error
+      #   in the response of subscribed_apps request.
+      #
+      # @param [String] access_token Access token of page to which bot has
+      #   to subscribe.
+      #
+      # @return [Boolean] TRUE
+      #
+      def subscribe(access_token:, subscribed_fields: [])
+        response = post '/subscribed_apps',
+                        headers: { 'Content-Type' => 'application/json' },
+                        body: {
+                          access_token: access_token,
+                          subscribed_fields: subscribed_fields
+                        }.to_json
+
+        raise_errors(response)
+
+        true
+      end
+
+      #
+      # Function unsubscribe the app from facebook page.
+      # @see https://developers.facebook.com/docs/graph-api/reference/page/subscribed_apps
+      #
+      # @raise [Facebook::Messenger::Subscriptions::Error] if there is any error
+      #   in the response of subscribed_apps request.
+      #
+      # @param [String] access_token Access token of page from which app has
+      #   to unsubscribe.
+      #
+      # @return [Boolean] TRUE
+      #
+      def unsubscribe(access_token:)
+        response = delete '/subscribed_apps', query: {
+          access_token: access_token
+        }
+
+        raise_errors(response)
+
+        true
+      end
+
+      #
+      # If there is any error in response, raise error.
+      #
+      # @raise [Facebook::Messenger::Subscriptions::Error] If there is error
+      #   in response.
+      #
+      # @param [Hash] response Response from facebook.
+      #
+      # @return Raise the error.
+      #
+      def raise_errors(response)
+        raise Error, response['error'] if response.key? 'error'
+      end
+
+      #
+      # Class Error provides errors related to subscriptions.
+      #
+      class Error < Facebook::Messenger::FacebookError; end
+    end
+  end
+end

data/lib/facebook/messenger/version.rb

@@ -0,0 +1,7 @@
+module Facebook
+  module Messenger
+    #
+    # @return [String] Define the version of gem.
+    VERSION = '2.1.2'.freeze
+  end
+end

data/lib/facebook/messenger.rb

@@ -0,0 +1,32 @@
+require 'facebook/messenger/version'
+require 'facebook/messenger/error'
+require 'facebook/messenger/subscriptions'
+require 'facebook/messenger/profile'
+require 'facebook/messenger/bot'
+require 'facebook/messenger/server'
+require 'facebook/messenger/server_no_error'
+require 'facebook/messenger/configuration'
+require 'facebook/messenger/incoming'
+
+module Facebook
+  # All the code for this gem resides in this module.
+  module Messenger
+    def self.configure
+      yield config
+    end
+
+    def self.config
+      @config ||= Configuration.new
+    end
+
+    def self.config=(config)
+      @config = config
+    end
+
+    # Set the default configuration provider.
+    # Developer can set different configuration provider.
+    configure do |config|
+      config.provider = Configuration::Providers::Environment.new
+    end
+  end
+end

metadata

@@ -0,0 +1,229 @@
+--- !ruby/object:Gem::Specification
+name: meta-messenger
+version: !ruby/object:Gem::Version
+  version: 2.1.2
+platform: ruby
+authors:
+- Johannes Gorset
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2025-06-11 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: httparty
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.13'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.13.7
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.13'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.13.7
+- !ruby/object:Gem::Dependency
+  name: rack
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.4.5
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.4.5
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.1'
+- !ruby/object:Gem::Dependency
+  name: coveralls
+  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: pry
+  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: rack-test
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.6.3
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.6.3
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 13.0.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 13.0.1
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.9'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.9'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.58.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.58.1
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.8.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.8.1
+description: Facebook Messenger client
+email:
+- jgorset@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- README.md
+- bin/console
+- bin/setup
+- lib/facebook/messenger.rb
+- lib/facebook/messenger/bot.rb
+- lib/facebook/messenger/bot/error_parser.rb
+- lib/facebook/messenger/bot/exceptions.rb
+- lib/facebook/messenger/bot/message_type.rb
+- lib/facebook/messenger/bot/messaging_type.rb
+- lib/facebook/messenger/bot/tag.rb
+- lib/facebook/messenger/configuration.rb
+- lib/facebook/messenger/configuration/app_secret_proof_calculator.rb
+- lib/facebook/messenger/configuration/providers.rb
+- lib/facebook/messenger/configuration/providers/base.rb
+- lib/facebook/messenger/configuration/providers/environment.rb
+- lib/facebook/messenger/error.rb
+- lib/facebook/messenger/incoming.rb
+- lib/facebook/messenger/incoming/account_linking.rb
+- lib/facebook/messenger/incoming/common.rb
+- lib/facebook/messenger/incoming/delivery.rb
+- lib/facebook/messenger/incoming/feed.rb
+- lib/facebook/messenger/incoming/feed_common.rb
+- lib/facebook/messenger/incoming/game_play.rb
+- lib/facebook/messenger/incoming/leadgen.rb
+- lib/facebook/messenger/incoming/message.rb
+- lib/facebook/messenger/incoming/message_echo.rb
+- lib/facebook/messenger/incoming/message_reaction.rb
+- lib/facebook/messenger/incoming/message_request.rb
+- lib/facebook/messenger/incoming/optin.rb
+- lib/facebook/messenger/incoming/pass_thread_control.rb
+- lib/facebook/messenger/incoming/payment.rb
+- lib/facebook/messenger/incoming/policy_enforcement.rb
+- lib/facebook/messenger/incoming/postback.rb
+- lib/facebook/messenger/incoming/read.rb
+- lib/facebook/messenger/incoming/referral.rb
+- lib/facebook/messenger/profile.rb
+- lib/facebook/messenger/server.rb
+- lib/facebook/messenger/server_no_error.rb
+- lib/facebook/messenger/subscriptions.rb
+- lib/facebook/messenger/version.rb
+homepage: https://github.com/hyperoslo/facebook-messenger
+licenses:
+- MIT
+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: []
+rubygems_version: 3.2.3
+signing_key:
+specification_version: 4
+summary: Facebook Messenger client
+test_files: []