gupshup-rb 0.1.7 → 0.1.8

data/lib/gupshup-rb/rest/client.rb

@@ -0,0 +1,581 @@
+##
+# This code was generated by
+# \ / _    _  _|   _  _
+#  | (_)\/(_)(_|\/| |(/_  v1.0.0
+#       /       /
+#
+# frozen_string_literal: true
+
+module Gupshup
+  module REST
+    ##
+    # A client for accessing the Gupshup API.
+    class Client
+      @@default_region = 'us1'
+
+      attr_accessor :http_client, :username, :password, :src_name, :api_key, :region, :edge, :logger, :user_agent_extensions
+
+      ##
+      # Initializes the Gupshup Client
+      def initialize(username=nil, password=nil, src_name=nil, region=nil, http_client=nil, logger=nil, user_agent_extensions=nil)
+        puts 'Gupshup'
+        puts Gupshup
+
+        binding.local_variables.each do |var_name|
+          var_value = binding.local_variable_get(var_name)
+          puts "#{var_name}: #{var_value}"
+        end
+        @src_name = src_name || Gupshup.src_name
+        @api_key = password || Gupshup.api_key
+        @auth = [@src_name, @api_key]
+        @logger = logger || Gupshup.logger
+        @user_agent_extensions = user_agent_extensions || []
+
+        # Domains
+        @api = nil
+        @content = nil
+        @conversations = nil
+        @events = nil
+        @media = nil
+        @messaging = nil
+        @video = nil
+      end
+
+      ##
+      # Makes a request to the Gupshup API using the configured http client
+      # Authentication information is automatically added if none is provided
+      def request(host, port, method, uri, params={}, data={}, headers={}, auth=nil, timeout=nil)
+        auth ||= @auth
+
+        ruby_config = RbConfig::CONFIG
+        headers['User-Agent'] = "gupshup-rb/#{Gupshup::VERSION} (#{ruby_config["host_os"]} #{ruby_config["host_cpu"]}) Ruby/#{RUBY_VERSION}"
+        headers['Accept-Charset'] = 'utf-8'
+
+        user_agent_extensions.each { |extension| headers['User-Agent'] += " #{extension}" }
+
+        if method == 'POST' && !headers['Content-Type']
+          headers['Content-Type'] = 'application/x-www-form-urlencoded'
+        end
+
+        unless headers['Accept']
+          headers['Accept'] = 'application/json'
+        end
+
+        uri = build_uri(uri)
+
+        if @logger
+          @logger.debug("--BEGIN Gupshup API Request--")
+          @logger.debug("Request Method: <#{method}>")
+
+          headers.each do |key, value|
+            unless key.downcase == 'authorization'
+              @logger.debug("#{key}:#{value}")
+            end
+          end
+
+          url = URI(uri)
+          @logger.debug("Host:#{url.host}")
+          @logger.debug("Path:#{url.path}")
+          @logger.debug("Query:#{url.query}")
+          @logger.debug("Request Params:#{params}")
+        end
+
+        response = @http_client.request(
+          host,
+          port,
+          method,
+          uri,
+          params,
+          data,
+          headers,
+          auth,
+          timeout
+        )
+
+        if @logger
+          @logger.debug("Response Status Code:#{response.status_code}")
+          @logger.debug("Response Headers:#{response.headers}")
+          @logger.debug("--END GUPSHUP API REQUEST--")
+        end
+
+        response
+      end
+
+      ##
+      # Build the final request uri
+      def build_uri(uri)
+        if @region.nil? and @edge.nil?
+          return uri
+        end
+
+        parsed_url = URI(uri)
+        pieces = parsed_url.host.split('.')
+        product = pieces[0]
+        domain = pieces[-2, 2]
+        new_edge = @edge
+        new_region = @region
+
+        if pieces.length == 4
+          new_region ||= pieces[1]
+        elsif pieces.length == 5
+          new_edge ||= pieces[1]
+          new_region ||= pieces[2]
+        end
+
+        if !new_edge.nil? && new_region.nil?
+          new_region = @@default_region
+        end
+
+        parsed_url.host = [product, new_edge, new_region, domain].select {|item| !item.nil?}.join('.')
+        parsed_url.to_s
+      end
+
+      ##
+      # Validate the new SSL certificate for the Gupshup API
+      def validate_ssl_certificate
+        response = request('api.gupshup.com', '8443', 'GET', 'https://api.gupshup.com:8443/.json')
+        if response.status_code < 200 || response.status_code >= 300
+          raise RestError.new 'Unexpected response from certificate endpoint', response
+        end
+      end
+
+      ##
+      # Access the Accounts Gupshup Domain
+      def accounts
+        @accounts ||= Accounts.new self
+      end
+
+      ##
+      # Access the Api Gupshup Domain
+      def api
+        @api ||= Api.new self
+      end
+
+      ##
+      # Access the Autopilot Gupshup Domain
+      def autopilot
+        @autopilot ||= Autopilot.new self
+      end
+
+      ##
+      # Access the Chat Gupshup Domain
+      def chat
+        @chat ||= Chat.new self
+      end
+
+      ##
+      # Access the Content Gupshup Domain
+      def content
+        @content ||= Content.new self
+      end
+
+      ##
+      # Access the Conversations Gupshup Domain
+      def conversations
+        @conversations ||= Conversations.new self
+      end
+
+      ##
+      # Access the Events Gupshup Domain
+      def events
+        @events ||= Events.new self
+      end
+
+      ##
+      # Access the FlexApi Gupshup Domain
+      def flex_api
+        @flex_api ||= FlexApi.new self
+      end
+
+      ##
+      # Access the FrontlineApi Gupshup Domain
+      def frontline_api
+        @frontline_api ||= FrontlineApi.new self
+      end
+
+      ##
+      # Access the Insights Gupshup Domain
+      def insights
+        @insights ||= Insights.new self
+      end
+
+      ##
+      # Access the IpMessaging Gupshup Domain
+      def ip_messaging
+        @ip_messaging ||= IpMessaging.new self
+      end
+
+      ##
+      # Access the Lookups Gupshup Domain
+      def lookups
+        @lookups ||= Lookups.new self
+      end
+
+      ##
+      # Access the Media Gupshup Domain
+      def media
+        @media ||= Media.new self
+      end
+
+      ##
+      # Access the Messaging Gupshup Domain
+      def messaging
+        @messaging ||= Messaging.new self
+      end
+
+      ##
+      # Access the Monitor Gupshup Domain
+      def monitor
+        @monitor ||= Monitor.new self
+      end
+
+      ##
+      # Access the Notify Gupshup Domain
+      def notify
+        @notify ||= Notify.new self
+      end
+
+      ##
+      # Access the Numbers Gupshup Domain
+      def numbers
+        @numbers ||= Numbers.new self
+      end
+
+      ##
+      # Access the Oauth Gupshup Domain
+      def oauth
+        @oauth ||= Oauth.new self
+      end
+
+      ##
+      # Access the Preview Gupshup Domain
+      def preview
+        @preview ||= Preview.new self
+      end
+
+      ##
+      # Access the Pricing Gupshup Domain
+      def pricing
+        @pricing ||= Pricing.new self
+      end
+
+      ##
+      # Access the Proxy Gupshup Domain
+      def proxy
+        @proxy ||= Proxy.new self
+      end
+
+      ##
+      # Access the Routes Gupshup Domain
+      def routes
+        @routes ||= Routes.new self
+      end
+
+      ##
+      # Access the Serverless Gupshup Domain
+      def serverless
+        @serverless ||= Serverless.new self
+      end
+
+      ##
+      # Access the Studio Gupshup Domain
+      def studio
+        @studio ||= Studio.new self
+      end
+
+      ##
+      # Access the Sync Gupshup Domain
+      def sync
+        @sync ||= Sync.new self
+      end
+
+      ##
+      # Access the Taskrouter Gupshup Domain
+      def taskrouter
+        @taskrouter ||= Taskrouter.new self
+      end
+
+      ##
+      # Access the Trunking Gupshup Domain
+      def trunking
+        @trunking ||= Trunking.new self
+      end
+
+      ##
+      # Access the Trusthub Gupshup Domain
+      def trusthub
+        @trusthub ||= Trusthub.new self
+      end
+
+      ##
+      # Access the Verify Gupshup Domain
+      def verify
+        @verify ||= Verify.new self
+      end
+
+      ##
+      # Access the Video Gupshup Domain
+      def video
+        @video ||= Video.new self
+      end
+
+      ##
+      # Access the Voice Gupshup Domain
+      def voice
+        @voice ||= Voice.new self
+      end
+
+      ##
+      # Access the Wireless Gupshup Domain
+      def wireless
+        @wireless ||= Wireless.new self
+      end
+
+      ##
+      # Access the Supersim Gupshup Domain
+      def supersim
+        @supersim ||= Supersim.new self
+      end
+
+      ##
+      # Access the Bulkexports Gupshup Domain
+      def bulkexports
+        @bulkexports ||= Bulkexports.new self
+      end
+
+      ##
+      # Access the Microvisor Gupshup Domain
+      def microvisor
+        @microvisor ||= Microvisor.new self
+      end
+
+      ##
+      # @param [String] sid The unique string that that we created to identify the
+      #   Address resource.
+      # @return [Gupshup::REST::Api::V2010::AccountContext::AddressInstance] if sid was passed.
+      # @return [Gupshup::REST::Api::V2010::AccountContext::AddressList]
+      def addresses(sid=:unset)
+        self.api.v2010.account.addresses(sid)
+      end
+
+      ##
+      # @param [String] sid The unique string that that we created to identify the
+      #   Application resource.
+      # @return [Gupshup::REST::Api::V2010::AccountContext::ApplicationInstance] if sid was passed.
+      # @return [Gupshup::REST::Api::V2010::AccountContext::ApplicationList]
+      def applications(sid=:unset)
+        self.api.v2010.account.applications(sid)
+      end
+
+      ##
+      # @param [String] connect_app_sid The SID that we assigned to the Connect App.
+      # @return [Gupshup::REST::Api::V2010::AccountContext::AuthorizedConnectAppInstance] if connect_app_sid was passed.
+      # @return [Gupshup::REST::Api::V2010::AccountContext::AuthorizedConnectAppList]
+      def authorized_connect_apps(connect_app_sid=:unset)
+        self.api.v2010.account.authorized_connect_apps(connect_app_sid)
+      end
+
+      ##
+      # @param [String] country_code The
+      #   {ISO-3166-1}[https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2] country code of
+      #   the country.
+      # @return [Gupshup::REST::Api::V2010::AccountContext::AvailablePhoneNumberCountryInstance] if country_code was passed.
+      # @return [Gupshup::REST::Api::V2010::AccountContext::AvailablePhoneNumberCountryList]
+      def available_phone_numbers(country_code=:unset)
+        self.api.v2010.account.available_phone_numbers(country_code)
+      end
+
+      ##
+      # @return [Gupshup::REST::Api::V2010::AccountContext::BalanceInstance]
+      def balance
+        self.api.v2010.account.balance
+      end
+
+      ##
+      # @param [String] sid The unique string that we created to identify this Call
+      #   resource.
+      # @return [Gupshup::REST::Api::V2010::AccountContext::CallInstance] if sid was passed.
+      # @return [Gupshup::REST::Api::V2010::AccountContext::CallList]
+      def calls(sid=:unset)
+        self.api.v2010.account.calls(sid)
+      end
+
+      ##
+      # @param [String] sid The unique string that that we created to identify this
+      #   Conference resource.
+      # @return [Gupshup::REST::Api::V2010::AccountContext::ConferenceInstance] if sid was passed.
+      # @return [Gupshup::REST::Api::V2010::AccountContext::ConferenceList]
+      def conferences(sid=:unset)
+        self.api.v2010.account.conferences(sid)
+      end
+
+      ##
+      # @param [String] sid The unique string that that we created to identify the
+      #   ConnectApp resource.
+      # @return [Gupshup::REST::Api::V2010::AccountContext::ConnectAppInstance] if sid was passed.
+      # @return [Gupshup::REST::Api::V2010::AccountContext::ConnectAppList]
+      def connect_apps(sid=:unset)
+        self.api.v2010.account.connect_apps(sid)
+      end
+
+      ##
+      # @param [String] sid The unique string that that we created to identify this
+      #   IncomingPhoneNumber resource.
+      # @return [Gupshup::REST::Api::V2010::AccountContext::IncomingPhoneNumberInstance] if sid was passed.
+      # @return [Gupshup::REST::Api::V2010::AccountContext::IncomingPhoneNumberList]
+      def incoming_phone_numbers(sid=:unset)
+        self.api.v2010.account.incoming_phone_numbers(sid)
+      end
+
+      ##
+      # @param [String] sid The unique string that that we created to identify the Key
+      #   resource.
+      # @return [Gupshup::REST::Api::V2010::AccountContext::KeyInstance] if sid was passed.
+      # @return [Gupshup::REST::Api::V2010::AccountContext::KeyList]
+      def keys(sid=:unset)
+        self.api.v2010.account.keys(sid)
+      end
+
+      ##
+      # @param [String] sid The unique string that that we created to identify the
+      #   Message resource.
+      # @return [Gupshup::REST::Api::V2010::AccountContext::MessageInstance] if sid was passed.
+      # @return [Gupshup::REST::Api::V2010::AccountContext::MessageList]
+      def messages(sid=:unset)
+        self.api.v2010.account.messages(sid)
+      end
+
+      ##
+      # @return [Gupshup::REST::Api::V2010::AccountContext::NewKeyInstance]
+      def new_keys
+        self.api.v2010.account.new_keys
+      end
+
+      ##
+      # @return [Gupshup::REST::Api::V2010::AccountContext::NewSigningKeyInstance]
+      def new_signing_keys
+        self.api.v2010.account.new_signing_keys
+      end
+
+      ##
+      # @param [String] sid The unique string that that we created to identify the
+      #   Notification resource.
+      # @return [Gupshup::REST::Api::V2010::AccountContext::NotificationInstance] if sid was passed.
+      # @return [Gupshup::REST::Api::V2010::AccountContext::NotificationList]
+      def notifications(sid=:unset)
+        self.api.v2010.account.notifications(sid)
+      end
+
+      ##
+      # @param [String] sid The unique string that that we created to identify the
+      #   OutgoingCallerId resource.
+      # @return [Gupshup::REST::Api::V2010::AccountContext::OutgoingCallerIdInstance] if sid was passed.
+      # @return [Gupshup::REST::Api::V2010::AccountContext::OutgoingCallerIdList]
+      def outgoing_caller_ids(sid=:unset)
+        self.api.v2010.account.outgoing_caller_ids(sid)
+      end
+
+      ##
+      # @param [String] sid The unique string that that we created to identify this
+      #   Queue resource.
+      # @return [Gupshup::REST::Api::V2010::AccountContext::QueueInstance] if sid was passed.
+      # @return [Gupshup::REST::Api::V2010::AccountContext::QueueList]
+      def queues(sid=:unset)
+        self.api.v2010.account.queues(sid)
+      end
+
+      ##
+      # @param [String] sid The unique string that that we created to identify the
+      #   Recording resource.
+      # @return [Gupshup::REST::Api::V2010::AccountContext::RecordingInstance] if sid was passed.
+      # @return [Gupshup::REST::Api::V2010::AccountContext::RecordingList]
+      def recordings(sid=:unset)
+        self.api.v2010.account.recordings(sid)
+      end
+
+      ##
+      # @param [String] sid The sid
+      # @return [Gupshup::REST::Api::V2010::AccountContext::SigningKeyInstance] if sid was passed.
+      # @return [Gupshup::REST::Api::V2010::AccountContext::SigningKeyList]
+      def signing_keys(sid=:unset)
+        self.api.v2010.account.signing_keys(sid)
+      end
+
+      ##
+      # @return [Gupshup::REST::Api::V2010::AccountContext::SipInstance]
+      def sip
+        self.api.v2010.account.sip
+      end
+
+      ##
+      # @param [String] sid The unique string that that we created to identify this
+      #   ShortCode resource.
+      # @return [Gupshup::REST::Api::V2010::AccountContext::ShortCodeInstance] if sid was passed.
+      # @return [Gupshup::REST::Api::V2010::AccountContext::ShortCodeList]
+      def short_codes(sid=:unset)
+        self.api.v2010.account.short_codes(sid)
+      end
+
+      ##
+      # @return [Gupshup::REST::Api::V2010::AccountContext::TokenInstance]
+      def tokens
+        self.api.v2010.account.tokens
+      end
+
+      ##
+      # @param [String] sid The unique string that that we created to identify the
+      #   Transcription resource.
+      # @return [Gupshup::REST::Api::V2010::AccountContext::TranscriptionInstance] if sid was passed.
+      # @return [Gupshup::REST::Api::V2010::AccountContext::TranscriptionList]
+      def transcriptions(sid=:unset)
+        self.api.v2010.account.transcriptions(sid)
+      end
+
+      ##
+      # @return [Gupshup::REST::Api::V2010::AccountContext::UsageInstance]
+      def usage
+        self.api.v2010.account.usage
+      end
+
+      ##
+      # @return [Gupshup::REST::Api::V2010::AccountContext::ValidationRequestInstance]
+      def validation_requests
+        self.api.v2010.account.validation_requests
+      end
+
+      ##
+      # Provide a user friendly representation
+      def to_s
+        "#<Gupshup::REST::Client #{@src_name}>"
+      end
+    end
+
+    ##
+    # Dummy client which provides no functionality. Please use Gupshup::REST::Client instead.
+    class BaseClient < ObsoleteClient; end
+
+    ##
+    # Dummy client which provides no functionality. Please use Gupshup::REST::Client instead.
+    class IpMessagingClient < ObsoleteClient; end
+
+    ##
+    # Dummy client which provides no functionality. Please use Gupshup::REST::Client instead.
+    class LookupsClient < ObsoleteClient; end
+
+    ##
+    # Dummy client which provides no functionality. Please use Gupshup::REST::Client instead.
+    class MonitorClient < ObsoleteClient; end
+
+    ##
+    # Dummy client which provides no functionality. Please use Gupshup::REST::Client instead.
+    class PricingClient < ObsoleteClient; end
+
+    ##
+    # Dummy client which provides no functionality. Please use Gupshup::REST::Client instead.
+    class TaskRouterClient < ObsoleteClient; end
+
+    ##
+    # Dummy client which provides no functionality. Please use Gupshup::REST::Client instead.
+    class TrunkingClient < ObsoleteClient; end
+  end
+end

data/lib/gupshup-rb/rest.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+Dir[File.join(__dir__, 'framework/rest/*.rb')].sort.each do |file|
+  require file
+end
+
+Dir[File.join(__dir__, 'rest/*.rb')].sort.each do |file|
+  require file
+end
+
+Dir[File.join(__dir__, 'rest/**/*.rb')].sort.each do |file|
+  require file
+end

data/lib/gupshup-rb/util/configuration.rb

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+module Gupshup
+  module Util
+    class Configuration
+      attr_accessor :src_name, :api_key, :http_client, :region, :edge, :logger
+
+      def src_name=(value)
+        @src_name = value
+      end
+
+      def api_key=(value)
+        @api_key = value
+      end
+
+      def http_client=(value)
+        @http_client = value
+      end
+
+      def region=(value)
+        @region = value
+      end
+
+      def edge=(value)
+        @edge = value
+      end
+
+      def logger=(value)
+        @logger = value
+      end
+    end
+  end
+end

data/lib/gupshup-rb/version.rb

@@ -0,0 +1,3 @@
+module Gupshup
+    VERSION = '0.1.8'
+end

data/lib/gupshup-rb.rb

@@ -0,0 +1,47 @@
+# frozen_string_literal: true
+
+require 'net/http'
+require 'net/https'
+require 'cgi'
+require 'openssl'
+require 'base64'
+require 'forwardable'
+require 'time'
+require 'json'
+
+require 'gupshup-rb/version' unless defined?(Gupshup::VERSION)
+require 'rack/gupshup_webhook_authentication' if defined?(Rack) && defined?(Rack::MediaType)
+
+require 'gupshup-rb/util'
+require 'gupshup-rb/security/request_validator'
+require 'gupshup-rb/util/configuration'
+
+Dir[File.join(__dir__, 'gupshup-rb/framework/*.rb')].sort.each do |file|
+  require file
+end
+
+module Gupshup
+  extend SingleForwardable
+
+  autoload :JWT, File.join(__dir__, 'gupshup-rb', 'jwt', 'jwt.rb')
+  autoload :TwiML, File.join(__dir__, 'gupshup-rb', 'twiml', 'twiml.rb')
+  autoload :HTTP, File.join(__dir__, 'gupshup-rb', 'http.rb')
+  autoload :REST, File.join(__dir__, 'gupshup-rb', 'rest.rb')
+
+  def_delegators :configuration, :src_name, :api_key, :http_client, :region, :edge, :logger
+
+  ##
+  # Pre-configure with account SID and auth token so that you don't need to
+  # pass them to various initializers each time.
+  def self.configure(&block)
+    yield configuration
+  end
+
+  ##
+  # Returns an existing or instantiates a new configuration object.
+  def self.configuration
+    @configuration ||= Util::Configuration.new
+  end
+
+  private_class_method :configuration
+end