cirro-ruby-client 1.6.0 → 2.0.0

data/lib/cirro_io/client/gig.rb

@@ -8,7 +8,6 @@ module CirroIO
       has_many :gig_results
       has_many :gig_time_activities
 
-      # rubocop:disable Metrics/AbcSize
       def bulk_create_with(worker_filter, gig_tasks)
         payload = { data: { attributes: attributes, relationships: {} } }
         payload[:data][:relationships][:gig_tasks] = gig_tasks.map(&:attributes)
@@ -35,7 +34,6 @@ module CirroIO
 
         self.class.parser.parse(self.class, response).first
       end
-      # rubocop:enable Metrics/AbcSize
     end
   end
 end

data/lib/cirro_io/client/gig_invitation.rb

@@ -4,6 +4,7 @@ module CirroIO
       include CirroIO::Client::BulkActionHelper
 
       has_one :gig
+      has_one :app_worker
 
       def bulk_create_with(worker_filter, auto_accept: false)
         payload = { data: { attributes: attributes.merge(worker_filter: worker_filter.attributes, auto_accept: auto_accept) } }

data/lib/cirro_io/client/gig_task.rb

@@ -1,6 +1,7 @@
 module CirroIO
   module Client
     class GigTask < Base
+      has_one :gig
     end
   end
 end

data/lib/cirro_io/client/gig_time_activity.rb

@@ -1,6 +1,7 @@
 module CirroIO
   module Client
     class GigTimeActivity < Base
+      has_one :gig
       has_one :app_worker
     end
   end

data/lib/cirro_io/client/version.rb

@@ -1,7 +1,7 @@
 # rubocop:disable Style/MutableConstant
 module CirroIO
   module Client
-    VERSION = '1.6.0'
+    VERSION = '2.0.0'
   end
 end
 # rubocop:enable Style/MutableConstant

data/lib/cirro_io_v2/client.rb

@@ -0,0 +1,106 @@
+require 'cirro_io/client/version'
+require 'cirro_io_v2/errors/http_error'
+require 'cirro_io_v2/errors/response_not_json_error'
+
+require 'cirro_io_v2/request_clients/base'
+require 'cirro_io_v2/request_clients/jwt'
+
+require 'cirro_io_v2/resources/base'
+require 'cirro_io_v2/resources/gig'
+require 'cirro_io_v2/resources/gig_ivitation'
+require 'cirro_io_v2/resources/user'
+
+require 'cirro_io_v2/responses/base'
+require 'cirro_io_v2/responses/responses'
+
+require 'cirro_io_v2/resources/notification_broadcast'
+require 'cirro_io_v2/resources/notification_topic_preference'
+require 'cirro_io_v2/resources/notification_topic'
+require 'cirro_io_v2/resources/notification_configuration'
+require 'cirro_io_v2/resources/notification_layout_template'
+require 'cirro_io_v2/resources/notification_layout'
+require 'cirro_io_v2/resources/notification_locale'
+require 'cirro_io_v2/resources/notification_template'
+
+module CirroIOV2
+  class Client
+    attr_accessor :request_client
+    attr_reader :options
+
+    DEFAULT_OPTIONS = {
+      site: 'https://api.cirro.io',
+      api_version: 'v2',
+      auth_type: :jwt,
+    }.freeze
+
+    DEFINED_OPTIONS = (DEFAULT_OPTIONS.keys + [:private_key, :private_key_path, :client_id]).freeze
+
+    def initialize(options = {})
+      @options = DEFAULT_OPTIONS.merge(options)
+
+      unknown_options = @options.keys.reject { |o| DEFINED_OPTIONS.include?(o) }
+      raise ArgumentError, "Unknown option(s) given: #{unknown_options}" unless unknown_options.empty?
+
+      # TODO: for now we only have jwt
+      case @options[:auth_type]
+      when :jwt
+        private_key = OpenSSL::PKey::RSA.new(@options[:private_key]) if @options[:private_key]
+        private_key = OpenSSL::PKey::RSA.new(File.read(@options[:private_key_path])) if @options[:private_key_path]
+        @request_client = RequestClients::Jwt.new(base_url: "#{@options[:site]}/#{@options[:api_version]}",
+                                                  client_id: @options[:client_id],
+                                                  private_key: private_key)
+      else
+        raise ArgumentError, 'Options: ":auth_type" must be ":jwt"'
+      end
+    end
+
+    # resources
+    # rubocop:disable Naming/MethodName
+
+    def User
+      Resources::User.new(self)
+    end
+
+    def GigInvitation
+      Resources::GigInvitation.new(self)
+    end
+
+    def Gig
+      Resources::Gig.new(self)
+    end
+
+    def NotificationBroadcast
+      Resources::NotificationBroadcast.new(self)
+    end
+
+    def NotificationChannelPreference
+      Resources::NotificationChannelPreference.new(self)
+    end
+
+    def NotificationChannel
+      Resources::NotificationChannel.new(self)
+    end
+
+    def NotificationConfiguration
+      Resources::NotificationConfiguration.new(self)
+    end
+
+    def NotificationLayoutTemplate
+      Resources::NotificationLayoutTemplate.new(self)
+    end
+
+    def NotificationLayout
+      Resources::NotificationLayout.new(self)
+    end
+
+    def NotificationLocale
+      Resources::NotificationLocale.new(self)
+    end
+
+    def NotificationTemplate
+      Resources::NotificationTemplate.new(self)
+    end
+
+    # rubocop:enable Naming/MethodName
+  end
+end

data/lib/cirro_io_v2/errors/http_error.rb

@@ -0,0 +1,17 @@
+require 'forwardable'
+
+module CirroIOV2
+  module Errors
+    class HTTPError < StandardError
+      extend Forwardable
+
+      def_instance_delegators :@response, :code
+      attr_reader :response, :message
+
+      def initialize(response)
+        @response = response
+        @message = response.try(:message).presence || response.try(:body)
+      end
+    end
+  end
+end

data/lib/cirro_io_v2/errors/response_not_json_error.rb

@@ -0,0 +1,17 @@
+require 'forwardable'
+
+module CirroIOV2
+  module Errors
+    class ResponseNotJsonError < StandardError
+      extend Forwardable
+
+      def_instance_delegators :@faraday_error, :message, :full_message, :response
+
+      attr_reader :faraday_error
+
+      def initialize(faraday_error)
+        @faraday_error = faraday_error
+      end
+    end
+  end
+end

data/lib/cirro_io_v2/request_clients/base.rb

@@ -0,0 +1,21 @@
+module CirroIOV2
+  module RequestClients
+    class Base
+      # Interface of all request clients. It returns the response if the request was successful (HTTP::2xx) and
+      # raises a CirroIOV2::HTTPError together with the response if the request was not successful
+
+      def request(*args, **named_args)
+        response = make_request(*args, **named_args)
+        raise Errors::HTTPError, response unless response.success?
+
+        response
+      rescue Faraday::ParsingError => e
+        raise Errors::ResponseNotJsonError, e
+      end
+
+      def make_request(*args)
+        raise NotImplementedError
+      end
+    end
+  end
+end

data/lib/cirro_io_v2/request_clients/jwt.rb

@@ -0,0 +1,41 @@
+require 'jwt'
+require 'openssl'
+
+module CirroIOV2
+  module RequestClients
+    class Jwt < Base
+      attr_reader :base_url, :private_key, :client_id, :connection
+
+      def initialize(base_url:, private_key:, client_id:)
+        @base_url = base_url
+        @private_key = private_key
+        @client_id = client_id
+
+        @connection = Faraday.new(url: base_url) do |conn|
+          conn.request :json
+          conn.response :json
+          conn.adapter Faraday.default_adapter # testIO App is on older version of faraday and needs this line
+        end
+      end
+
+      def make_request(http_method, url, body: nil, params: nil, _headers: {})
+        @connection.send(http_method, url) do |request|
+          request.params = params if params
+          request.body = body.to_json if body
+          request.headers['Authorization'] = bearer_token
+        end
+      end
+
+      def bearer_token
+        payload = {
+          exp: Time.now.to_i + (10 * 60),
+          sub: client_id,
+        }
+
+        token = JWT.encode(payload, private_key, 'RS256')
+
+        "Bearer #{token}"
+      end
+    end
+  end
+end

data/lib/cirro_io_v2/resources/base.rb

@@ -0,0 +1,21 @@
+require 'active_support/core_ext/string/inflections'
+
+module CirroIOV2
+  module Resources
+    class Base
+      attr_reader :client
+
+      def initialize(client)
+        @client = client
+      end
+
+      def resource_root
+        self.class.name.demodulize.underscore.pluralize
+      end
+
+      def params_allowed?(params, allowed)
+        raise 'ParamNotAllowed' if (params.keys - allowed).any?
+      end
+    end
+  end
+end

data/lib/cirro_io_v2/resources/gig.rb

@@ -0,0 +1,10 @@
+module CirroIOV2
+  module Resources
+    class Gig < Base
+      def create(params)
+        response = client.request_client.request(:post, resource_root, body: params)
+        Responses::GigResponse.new(response.body)
+      end
+    end
+  end
+end

data/lib/cirro_io_v2/resources/gig_ivitation.rb

@@ -0,0 +1,18 @@
+module CirroIOV2
+  module Resources
+    class GigInvitation < Base
+      ALLOWED_PARAMS = [:user_id, :gig_id, :limit, :before, :after, :status].freeze
+
+      def list(params = nil)
+        params_allowed?(params, ALLOWED_PARAMS) if params
+        response = client.request_client.request(:get, resource_root, params: params)
+        Responses::GigInvitationListResponse.new(response.body)
+      end
+
+      def accept(id)
+        response = client.request_client.request(:post, "#{resource_root}/#{id}/accept")
+        Responses::GigInvitationResponse.new(response.body)
+      end
+    end
+  end
+end

data/lib/cirro_io_v2/resources/notification_broadcast.rb

@@ -0,0 +1,13 @@
+module CirroIOV2
+  module Resources
+    class NotificationBroadcast < Base
+      ALLOWED_PARAMS = [:payload, :recipients, :notification_channel_id].freeze
+
+      def create(params)
+        params_allowed?(params, ALLOWED_PARAMS)
+        response = client.request_client.request(:post, resource_root, body: params)
+        Responses::NotificationBroadcastResponse.new(response.body)
+      end
+    end
+  end
+end

data/lib/cirro_io_v2/resources/notification_configuration.rb

@@ -0,0 +1,13 @@
+module CirroIOV2
+  module Resources
+    class NotificationConfiguration < Base
+      ALLOWED_PARAMS = [:locale, :limit, :before, :after].freeze
+
+      def list(params = nil)
+        params_allowed?(params, ALLOWED_PARAMS) if params
+        response = client.request_client.request(:get, resource_root, params: params)
+        Responses::NotificationConfigurationListResponse.new(response.body)
+      end
+    end
+  end
+end

data/lib/cirro_io_v2/resources/notification_layout.rb

@@ -0,0 +1,27 @@
+module CirroIOV2
+  module Resources
+    class NotificationLayout < Base
+      CREATE_ALLOWED_PARAMS = [:name, :templates].freeze
+      UPDATE_ALLOWED_PARAMS = [:name].freeze
+      CREATE_TEMPLATE_ALLOWED_PARAMS = [:notification_configuration_id, :body].freeze
+
+      def create(params)
+        params_allowed?(params, CREATE_ALLOWED_PARAMS)
+        response = client.request_client.request(:post, resource_root, body: params)
+        Responses::NotificationLayoutResponse.new(response.body)
+      end
+
+      def update(id, params)
+        params_allowed?(params, UPDATE_ALLOWED_PARAMS)
+        response = client.request_client.request(:post, "#{resource_root}/#{id}", body: params)
+        Responses::NotificationLayoutResponse.new(response.body)
+      end
+
+      def create_template(id, params)
+        params_allowed?(params, CREATE_TEMPLATE_ALLOWED_PARAMS)
+        response = client.request_client.request(:post, "#{resource_root}/#{id}/notification_layout_templates", body: params)
+        Responses::NotificationLayoutTemplateResponse.new(response.body)
+      end
+    end
+  end
+end

data/lib/cirro_io_v2/resources/notification_layout_template.rb

@@ -0,0 +1,18 @@
+module CirroIOV2
+  module Resources
+    class NotificationLayoutTemplate < Base
+      UPDATE_ALLOWED_PARAMS = [:notification_configuration_id, :body].freeze
+
+      def update(id, params)
+        params_allowed?(params, UPDATE_ALLOWED_PARAMS)
+        response = client.request_client.request(:post, "#{resource_root}/#{id}", body: params)
+        Responses::NotificationLayoutTemplateResponse.new(response.body)
+      end
+
+      def delete(id)
+        response = client.request_client.request(:delete, "#{resource_root}/#{id}")
+        Responses::NotificationLayoutTemplateDeleteResponse.new(response.body)
+      end
+    end
+  end
+end

data/lib/cirro_io_v2/resources/notification_locale.rb

@@ -0,0 +1,18 @@
+module CirroIOV2
+  module Resources
+    class NotificationLocale < Base
+      ALLOWED_PARAMS = [:locale].freeze
+
+      def create(params)
+        params_allowed?(params, ALLOWED_PARAMS)
+        response = client.request_client.request(:post, resource_root, body: params)
+        Responses::NotificationLocaleResponse.new(response.body)
+      end
+
+      def list
+        response = client.request_client.request(:get, resource_root)
+        Responses::NotificationLocaleListResponse.new(response.body)
+      end
+    end
+  end
+end

data/lib/cirro_io_v2/resources/notification_template.rb

@@ -0,0 +1,25 @@
+module CirroIOV2
+  module Resources
+    class NotificationTemplate < Base
+      LIST_ALLOWED_PARAMS = [:notification_configuration_id, :notification_channel_id, :limit, :before, :after].freeze
+      UPDATE_ALLOWED_PARAMS = [:subject, :body].freeze
+
+      def list(params = nil)
+        params_allowed?(params, LIST_ALLOWED_PARAMS) if params
+        response = client.request_client.request(:get, resource_root, params: params)
+        Responses::NotificationTemplateListResponse.new(response.body)
+      end
+
+      def update(id, params)
+        params_allowed?(params, UPDATE_ALLOWED_PARAMS)
+        response = client.request_client.request(:post, "#{resource_root}/#{id}", body: params)
+        Responses::NotificationTemplateResponse.new(response.body)
+      end
+
+      def delete(id)
+        response = client.request_client.request(:delete, "#{resource_root}/#{id}")
+        Responses::NotificationTemplateDeleteResponse.new(response.body)
+      end
+    end
+  end
+end

data/lib/cirro_io_v2/resources/notification_topic.rb

@@ -0,0 +1,17 @@
+module CirroIOV2
+  module Resources
+    class NotificationTopic < Base
+      ALLOWED_PARAMS = [:name, :notification_layout_id, :preferences, :templates].freeze
+
+      def resource_root
+        'notification_channels'
+      end
+
+      def create(params)
+        params_allowed?(params, ALLOWED_PARAMS)
+        response = client.request_client.request(:post, resource_root, body: params)
+        Responses::NotificationChannelResponse.new(response.body)
+      end
+    end
+  end
+end

data/lib/cirro_io_v2/resources/notification_topic_preference.rb

@@ -0,0 +1,17 @@
+module CirroIOV2
+  module Resources
+    class NotificationTopicPreference < Base
+      ALLOWED_PARAMS = [:user_id, :notification_channel_id, :limit, :before, :after].freeze
+
+      def resource_root
+        'notification_channel_preferences'
+      end
+
+      def list(params = nil)
+        params_allowed?(params, ALLOWED_PARAMS) if params
+        response = client.request_client.request(:get, resource_root, params: params)
+        Responses::NotificationChannelPreferenceListResponse.new(response.body)
+      end
+    end
+  end
+end

data/lib/cirro_io_v2/resources/user.rb

@@ -0,0 +1,15 @@
+module CirroIOV2
+  module Resources
+    class User < Base
+      def find(id)
+        response = client.request_client.request(:get, "#{resource_root}/#{id}")
+        CirroIOV2::Responses::UserResponse.new(response.body)
+      end
+
+      def notification_preferences(id, params)
+        response = client.request_client.request(:post, "#{resource_root}/#{id}/notification_preferences", body: params)
+        CirroIOV2::Responses::UserNotificationPreferenceResponse.new(response.body)
+      end
+    end
+  end
+end

data/lib/cirro_io_v2/responses/base.rb

@@ -0,0 +1,32 @@
+module CirroIOV2
+  module Responses
+    module Base
+      def initialize(body)
+        body = body.deep_symbolize_keys
+        if body[:object] == 'list'
+          list_item_class = self.class.name.gsub('List', '').constantize
+          values_hash = body.slice(*members.excluding(:data)).merge(
+            data: body[:data].map { |list_item| list_item_class.new(list_item) },
+          )
+          super(*members.map { |attr| values_hash[attr] })
+        elsif list_attribute(body)
+          values_hash = body.slice(*members.excluding(list_attribute(body))).merge(
+            list_attribute(body) => create_sub_resource(list_attribute(body), body[list_attribute(body)]),
+          )
+          super(*body.slice(*members).keys.map { |attr| values_hash[attr] })
+        else
+          super(*body.slice(*members).values)
+        end
+      end
+
+      def list_attribute(data)
+        data.keys.find { |key| data[key].is_a?(Hash) && data[key][:object] == 'list' }
+      end
+
+      def create_sub_resource(resource_name, body)
+        sub_resource_class = "CirroIOV2::Responses::#{self.class::NESTED_RESPONSES[resource_name]}".constantize
+        sub_resource_class.new(body)
+      end
+    end
+  end
+end

data/lib/cirro_io_v2/responses/responses.rb

@@ -0,0 +1,101 @@
+module CirroIOV2
+  module Responses
+    LIST_RESPONSES = [
+      :GigTaskListResponse,
+      :GigInvitationListResponse,
+      :NotificationChannelPreferenceListResponse,
+      :NotificationLocaleListResponse,
+      :NotificationConfigurationListResponse,
+      :NotificationLayoutTemplateListResponse,
+      :NotificationChannelListResponse,
+      :NotificationTemplateListResponse,
+    ].freeze
+
+    UserResponse = Struct.new(:id, :object, :first_name, :last_name, :time_zone, :screen_name, :country_code, :epam, :worker) do
+      include Base
+    end
+
+    UserNotificationPreferenceResponse = Struct.new(:id, :object, :locale, :channels) do
+      self::NESTED_RESPONSES = { channels: :NotificationChannelListResponse }.freeze
+      include Base
+    end
+
+    GigResponse = Struct.new(:id,
+                             :object,
+                             :title,
+                             :description,
+                             :url,
+                             :start_at,
+                             :end_at,
+                             :total_seats,
+                             :invitation_mode,
+                             :filter_query,
+                             :tasks,
+                             :notification_payload,
+                             :epam_options) do
+      self::NESTED_RESPONSES = { tasks: :GigTaskListResponse }.freeze
+      include Base
+    end
+
+    GigTaskResponse = Struct.new(:id, :object, :title, :base_price) do
+      include Base
+    end
+
+    GigInvitationResponse = Struct.new(:id, :object, :status, :gig_id, :user_id) do
+      include Base
+    end
+
+    NotificationChannelPreferenceResponse = Struct.new(:id, :object, :preferences, :notification_channel_id, :user_id) do
+      self::NESTED_RESPONSES = { preferences: :NotificationChannelPreferenceListResponse }.freeze
+      include Base
+    end
+
+    NotificationLocaleResponse = Struct.new(:id, :object, :locale, :default, :configurations) do
+      self::NESTED_RESPONSES = { configurations: :NotificationConfigurationListResponse }.freeze
+      include Base
+    end
+
+    NotificationConfigurationResponse = Struct.new(:id, :object, :deliver_by, :format, :kind, :locale) do
+      include Base
+    end
+
+    NotificationLayoutResponse = Struct.new(:id, :object, :name, :templates) do
+      self::NESTED_RESPONSES = { templates: :NotificationLayoutTemplateListResponse }.freeze
+      include Base
+    end
+
+    NotificationLayoutTemplateResponse = Struct.new(:id, :notification_configuration_id, :notification_layout_id, :body) do
+      include Base
+    end
+
+    NotificationLayoutTemplateDeleteResponse = Struct.new(:id, :object, :deleted) do
+      include Base
+    end
+
+    NotificationChannelResponse = Struct.new(:id, :object, :name, :notification_layout_id, :preferences, :templates) do
+      self::NESTED_RESPONSES = { templates: :NotificationTemplateListResponse }.freeze
+      include Base
+    end
+
+    NotificationTemplateResponse = Struct.new(:id, :object, :notification_configuration_id, :notification_channel_id, :subject, :body) do
+      include Base
+    end
+
+    NotificationTemplateDeleteResponse = Struct.new(:id, :object, :deleted) do
+      include Base
+    end
+
+    NotificationBroadcastResponse = Struct.new(:id, :object, :payload, :recipients, :notification_channel_id) do
+      include Base
+    end
+
+    # cover the list responses
+    def self.const_missing(name)
+      return const_get(name) if const_defined? name
+      return unless LIST_RESPONSES.include? name
+
+      klass = Class.new(Struct.new(:object, :url, :has_more, :data)) { include Base }
+      const_set(name, klass)
+    end
+  end
+end