line-bot 0.1.7

data/lib/line/bot.rb

@@ -0,0 +1,14 @@
+require 'line/bot/client'
+require 'line/bot/api/errors'
+require 'line/bot/api'
+require 'line/bot/event_type'
+require 'line/bot/message'
+require 'line/bot/operation'
+require 'line/bot/receive/message'
+require 'line/bot/receive/operation'
+require 'line/bot/receive/request'
+require 'line/bot/response/user/profile'
+require 'line/bot/request'
+require 'line/bot/httpclient'
+require 'line/bot/utils'
+require 'line/bot/api/version'

data/lib/line/bot/api.rb

@@ -0,0 +1,8 @@
+module Line
+  module Bot
+    module API
+      DEFAULT_ENDPOINT = "https://trialbot-api.line.me/v1"
+      DEFAULT_SENDING_MESSAGE_CHANNEL_ID = 1383378250
+    end
+  end
+end

data/lib/line/bot/api/errors.rb

@@ -0,0 +1,9 @@
+module Line
+  module Bot
+    module API
+      class Error < StandardError; end
+      class InvalidCredentialsError < Error; end
+      class NotSupportedError < Error; end
+    end
+  end
+end

data/lib/line/bot/api/version.rb

@@ -0,0 +1,7 @@
+module Line
+  module Bot
+    module API
+      VERSION = "0.1.7"
+    end
+  end
+end

data/lib/line/bot/builder/multiple_message.rb

@@ -0,0 +1,101 @@
+require 'line/bot/message'
+
+module Line
+  module Bot
+    module Builder
+      class MultipleMessage
+
+        def initialize(client)
+          @messages ||= []
+          @client = client
+        end
+
+        def add_text(attrs = {})
+          tap {
+            message = Message::Text.new(
+              text: attrs[:text],
+            )
+            push_message(message)
+          }
+        end
+
+        def add_image(attrs = {})
+          tap {
+            message = Message::Image.new(
+              image_url: attrs[:image_url],
+              preview_url: attrs[:preview_url],
+            )
+            push_message(message)
+          }
+        end
+
+        def add_video(attrs = {})
+          tap {
+            message = Message::Video.new(
+              video_url: attrs[:video_url],
+              preview_url: attrs[:preview_url],
+            )
+            push_message(message)
+          }
+        end
+
+        def add_audio(attrs = {})
+          tap {
+            message = Message::Audio.new(
+              audio_url: attrs[:audio_url],
+              duration: attrs[:duration],
+            )
+            push_message(message)
+          }
+        end
+
+        def add_location(attrs = {})
+          tap {
+            message = Message::Location.new(
+              title: attrs[:title],
+              latitude: attrs[:latitude],
+              longitude: attrs[:longitude],
+            )
+            push_message(message)
+          }
+        end
+
+        def add_sticker(attrs = {})
+          tap {
+            message = Message::Sticker.new(
+              stkpkgid: attrs[:stkpkgid],
+              stkid: attrs[:stkid],
+              stkver: attrs[:stkver],
+            )
+            push_message(message)
+          }
+        end
+
+        def push_message(message)
+          raise ArgumentError, "Invalid argument: `message`" unless message.valid?
+          @messages << message.content
+        end
+
+        def send(attrs = {})
+          @client.send_message(attrs[:to_mid], self)
+        end
+
+        def event_type
+          Line::Bot::EventType::MULTIPLE_MESSAGE
+        end
+
+        def content
+          {
+            messageNotified: 0,
+            messages: @messages
+          }
+        end
+
+        def valid?
+          @messages.size > 0
+        end
+
+      end
+    end
+  end
+end

data/lib/line/bot/builder/rich_message.rb

@@ -0,0 +1,139 @@
+require 'line/bot/message'
+require 'json'
+
+module Line
+  module Bot
+    module Builder
+      class RichMessage
+
+        def initialize(client)
+          @actions ||= {}
+          @listeners ||= []
+          @client = client
+        end
+
+        def set_action(attrs = {})
+          tap {
+            attrs.each { |key, value|
+              raise ArgumentError, 'Invalid arguments, :text, :link_url keys.' unless validate_action_attributes(value)
+
+              @actions[key.to_s] = {
+                type: 'web',
+                text: value[:text].to_s,
+                params: {
+                  linkUri: value[:link_url].to_s
+                },
+              }
+            }
+          }
+        end
+
+        def validate_action_attributes(attrs = {})
+          attrs[:text] && attrs[:link_url]
+        end
+
+        def add_listener(attrs = {})
+          tap {
+            raise ArgumentError, 'Invalid arguments, :x, :y, :width, :height keys.' unless validate_listener_attributes(attrs)
+
+            listener = {
+              type: 'touch', # Fixed "touch".
+              params: [attrs[:x].to_i, attrs[:y].to_i, attrs[:width].to_i, attrs[:height].to_i],
+              action: attrs[:action].to_s,
+            }
+            @listeners << listener
+          }
+        end
+
+        def validate_listener_attributes(attrs = {})
+          attrs[:action] &&
+          attrs[:x] &&
+          attrs[:y] &&
+          attrs[:width] &&
+          attrs[:height]
+        end
+
+        # send rich message to line server and to users
+        #
+        # @param attrs [Hash]
+        # @param attrs [:to_mid] [String or Array] line user's mids
+        # @param attrs [:image_url] [String] image file's url
+        # @param attrs [:alt_text] [String] alt text for image file's url
+        # @raise [ArgumentError] Error raised when supplied argument are missing :to_mid, :image_url, :preview_url keys.
+        #
+        # @return [Net::HTTPResponse] response for a request to line server
+        def send(attrs = {})
+          @image_url = attrs[:image_url]
+          @alt_text = attrs[:alt_text]
+
+          @client.send_message(attrs[:to_mid], self)
+        end
+
+        def height
+          height = 0
+          @listeners.each { |listener|
+            h = listener[:params][1] + listener[:params][3] # params.y + params.height
+            height = h if height < h
+          }
+
+          height > 2080 ? 2080 : height
+        end
+
+        def event_type
+          Line::Bot::EventType::MESSAGE
+        end
+
+        def content
+          {
+            contentType: Line::Bot::Message::ContentType::RICH_MESSAGE,
+            toType: Line::Bot::Message::RecipientType::USER,
+            contentMetadata: {
+              DOWNLOAD_URL: @image_url,
+              SPEC_REV: "1", # Fixed "1".
+              ALT_TEXT: @alt_text,
+              MARKUP_JSON: markup.to_json,
+            },
+          }
+        end
+
+        def valid?
+          @image_url && @alt_text
+        end
+
+        def markup
+          {
+            canvas: {
+              height: height,
+              width: 1040, # Integer fixed value: 1040
+              initialScene: 'scene1',
+            },
+            images: {
+              image1: {
+                x: 0,
+                y: 0,
+                w: 1040, # Integer fixed value: 1040
+                h: height
+              },
+            },
+            actions: @actions,
+            scenes: {
+              scene1: {
+                draws: [
+                  {
+                    image: 'image1', # Use the image ID "image1".
+                    x: 0,
+                    y: 0,
+                    w: 1040, # Integer fixed value: 1040
+                    h: height
+                  },
+                ],
+                listeners: @listeners
+              }
+            }
+          }
+        end
+
+      end
+    end
+  end
+end

data/lib/line/bot/client.rb

@@ -0,0 +1,303 @@
+require 'line/bot/message'
+require 'line/bot/request'
+require 'line/bot/builder/rich_message'
+require 'line/bot/builder/multiple_message'
+require 'line/bot/api/errors'
+require 'base64'
+require 'net/http'
+
+module Line
+  module Bot
+    class Client
+
+      include Line::Bot::Utils
+
+      #  @return [String]
+      attr_accessor :channel_id, :channel_secret, :channel_mid, :endpoint, :to_channel_id, :httpclient
+
+      # Initialize a new Bot Client.
+      #
+      # @param options [Hash]
+      #
+      # @return [Line::Bot::Client]
+      def initialize(options = {})
+        options.each do |key, value|
+          instance_variable_set("@#{key}", value)
+        end
+        yield(self) if block_given?
+
+        @httpclient ||= Line::Bot::HTTPClient.new
+      end
+
+      def endpoint
+        @endpoint ||= Line::Bot::API::DEFAULT_ENDPOINT
+      end
+
+      def to_channel_id
+        @to_channel_id ||= Line::Bot::API::DEFAULT_SENDING_MESSAGE_CHANNEL_ID
+      end
+
+      # @return [Hash]
+      def credentials
+        {
+          'X-Line-ChannelID' => channel_id,
+          'X-Line-ChannelSecret' => channel_secret,
+          'X-Line-Trusted-User-With-ACL' => channel_mid,
+        }
+      end
+
+      def credentials?
+        credentials.values.all?
+      end
+
+      # Send text to users.
+      #
+      # @param attrs [Hash]
+      #   @param to_mid [String or Array] User's identifiers
+      #   @param text [String]
+      #
+      # @raise [ArgumentError] Error raised when supplied argument are missing :to_mid, :text keys.
+      #
+      # @return [Net::HTTPResponse]
+      def send_text(attrs = {})
+        message = Message::Text.new(
+          text: attrs[:text],
+        )
+        send_message(attrs[:to_mid], message)
+      end
+
+      # Send image to users.
+      #
+      # @param attrs [Hash]
+      #   @param to_mid [String or Array] User's identifiers
+      #   @param image_url [String] Image file's url
+      #   @param preview_url [String] Preview image file's url
+      #
+      # @raise [ArgumentError] Error raised when supplied argument are missing :to_mid, :image_url, :preview_url keys.
+      #
+      # @return [Net::HTTPResponse]
+      def send_image(attrs = {})
+        message = Message::Image.new(
+          image_url: attrs[:image_url],
+          preview_url: attrs[:preview_url],
+        )
+        send_message(attrs[:to_mid], message)
+      end
+
+      # Send video to users.
+      #
+      # @param attrs [Hash]
+      #   @param to_mid [String or Array] User's identifiers
+      #   @param video_url [String] Video file's url
+      #   @param preview_url [String] Preview image file's url
+      #
+      # @raise [ArgumentError] Error raised when supplied argument are missing :to_mid, :video_url, :preview_url keys.
+      #
+      # @return [Net::HTTPResponse]
+      def send_video(attrs = {})
+        message = Message::Video.new(
+          video_url: attrs[:video_url],
+          preview_url: attrs[:preview_url],
+        )
+        send_message(attrs[:to_mid], message)
+      end
+
+      # Send audio to users.
+      #
+      # @param attrs [Hash]
+      #   @param to_mid [String or Array] User's identifiers
+      #   @param audio_url [String] Audio file's url
+      #   @param duration [String or Integer] Voice message's length, milliseconds
+      #
+      # @raise [ArgumentError] Error raised when supplied argument are missing :to_mid, :audio_url, :duration keys.
+      #
+      # @return [Net::HTTPResponse]
+      def send_audio(attrs = {})
+        message = Message::Audio.new(
+          audio_url: attrs[:audio_url],
+          duration: attrs[:duration],
+        )
+        send_message(attrs[:to_mid], message)
+      end
+
+      # Send location to users.
+      #
+      # @param attrs [Hash]
+      #   @param to_mid [String or Array] User's identifiers
+      #   @param title [String] Location's title
+      #   @param address [String] Location's address
+      #   @param latitude [Float] Location's latitude
+      #   @param longitude [Float] Location's longitude
+      #
+      # @raise [ArgumentError] Error raised when supplied argument are missing :to_mid, :title, :latitude, :longitude keys.
+      #
+      # @return [Net::HTTPResponse]
+      def send_location(attrs = {})
+        message = Message::Location.new(
+          title: attrs[:title],
+          address: attrs[:address],
+          latitude: attrs[:latitude],
+          longitude: attrs[:longitude],
+        )
+        send_message(attrs[:to_mid], message)
+      end
+
+      # Send sticker to users.
+      #
+      # @param attrs [Hash]
+      #   @param to_mid [String or Array] User's identifiers
+      #   @param stkpkgid [String or Integer] Sticker's package identifier
+      #   @param stkid [String or Integer] Sticker's identifier
+      #   @param stkver [String or Integer] Sticker's version number
+      #
+      # @raise [ArgumentError] Error raised when supplied argument are missing :to_mid, :stkpkgid, :stkid, :stkver keys.
+      #
+      # @return [Net::HTTPResponse]
+      def send_sticker(attrs = {})
+        message = Message::Sticker.new(
+          stkpkgid: attrs[:stkpkgid],
+          stkid: attrs[:stkid],
+          stkver: attrs[:stkver],
+        )
+        send_message(attrs[:to_mid], message)
+      end
+
+      # Send message to line server and to users.
+      #
+      # @param to_mid [String or Array] User's identifiers
+      # @param message [Line::Bot::Message]
+      #
+      # @raise [ArgumentError] Error raised when supplied argument are missing message.
+      #
+      # @return [Net::HTTPResponse]
+      def send_message(to_mid, message)
+        raise Line::Bot::API::InvalidCredentialsError, 'Invalidates credentials' unless credentials?
+
+        request = Request.new do |config|
+          config.to_channel_id  = to_channel_id
+          config.httpclient     = httpclient
+          config.endpoint       = endpoint
+          config.endpoint_path  = '/events'
+          config.credentials    = credentials
+          config.to_mid         = to_mid
+          config.message        = message
+        end
+
+        request.post
+      end
+
+      # Get message content.
+      #
+      # @param identifier [String] Message's identifier
+      #
+      # @raise [ArgumentError] Error raised when supplied argument are missing message.
+      #
+      # @return [Net::HTTPResponse]
+      def get_message_content(identifier)
+        endpoint_path  = "/bot/message/#{identifier}/content"
+        get(endpoint_path)
+      end
+
+      # Get preview of message content.
+      #
+      # @param identifier [String] Message's identifier
+      #
+      # @raise [ArgumentError] Error raised when supplied argument are missing message.
+      #
+      # @return [Net::HTTPResponse]
+      def get_message_content_preview(identifier)
+        endpoint_path  = "/bot/message/#{identifier}/content/preview"
+        get(endpoint_path)
+      end
+
+      # Get user profile.
+      #
+      # @param mids [String or Array] User's identifiers
+      #
+      # @raise [ArgumentError] Error raised when supplied argument are missing message.
+      # @raise [HTTPError]
+      #
+      # @return [Line::Bot::Response::User::Profile]
+      def get_user_profile(mids)
+        raise ArgumentError, 'Wrong argument type `mids`' unless validate_mids(mids)
+
+        query = mids.is_a?(Array) ? mids.join(',') : mids
+        endpoint_path  = "/profiles?mids=#{query}"
+
+        response = get(endpoint_path)
+
+        Line::Bot::Response::User::Profile.new(response) if !response.value
+      end
+
+      # Fetch data, get content of specified URL.
+      #
+      # @param endpoint_path [String]
+      #
+      # @return [Net::HTTPResponse]
+      def get(endpoint_path)
+        raise Line::Bot::API::InvalidCredentialsError, 'Invalidates credentials' unless credentials?
+
+        request = Request.new do |config|
+          config.to_channel_id  = to_channel_id
+          config.httpclient     = httpclient
+          config.endpoint       = endpoint
+          config.endpoint_path  = endpoint_path
+          config.credentials    = credentials
+        end
+
+        request.get
+      end
+
+      # Create rich message to line server and to users.
+      #
+      # @return [Line::Bot::Builder::RichMessage]
+      def rich_message
+        Line::Bot::Builder::RichMessage.new(self)
+      end
+
+      # Create multiple message to line server and to users.
+      #
+      # @return [Line::Bot::Builder::MultipleMessage]
+      def multiple_message
+        Line::Bot::Builder::MultipleMessage.new(self)
+      end
+
+      # Validate signature
+      #
+      # @param content [String] Request's body
+      # @param channel_signature [String] Request'header 'X-LINE-ChannelSignature' # HTTP_X_LINE_CHANNELSIGNATURE
+      #
+      # @return [Boolean]
+      def validate_signature(content = "", channel_signature)
+        return false unless !channel_signature.nil? && credentials?
+
+        hash = OpenSSL::HMAC::digest(OpenSSL::Digest::SHA256.new, channel_secret, content)
+        signature = Base64.strict_encode64(hash)
+
+        variable_secure_compare(channel_signature, signature)
+      end
+
+    private
+      # Constant time string comparison.
+      #
+      # via timing attacks.
+      # reference: https://github.com/rails/rails/blob/master/activesupport/lib/active_support/security_utils.rb
+      # @return [Boolean]
+      def variable_secure_compare(a, b)
+        secure_compare(::Digest::SHA256.hexdigest(a), ::Digest::SHA256.hexdigest(b))
+      end
+
+      # @return [Boolean]
+      def secure_compare(a, b)
+        return false unless a.bytesize == b.bytesize
+
+        l = a.unpack "C#{a.bytesize}"
+
+        res = 0
+        b.each_byte { |byte| res |= byte ^ l.shift }
+        res == 0
+      end
+    end
+
+  end
+end