fresh_service_api_v2_client 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: f907ae6b108ec816a765681f148d5277149919255136d52202afcd6db7db4fac
+  data.tar.gz: a756eb8fba3108d0f10f7b6cdec66ba86d43f2045fc275b6411a4c3028b10a0e
+SHA512:
+  metadata.gz: 62dcabeb3230e320d7ef464056a21542174c45a55cbcac191145b088818c19386357b8b1a85c61916cec256f88609fc7e865cc460bc6b19dffa9da883a08dfa6
+  data.tar.gz: b305b01bd36e318701e07dd06d64ee0d04a7d5de0a1cf07f6da2acc175f91879d87a6948bfed7f2a27aa5b64c920ee0c42ae560e36d54c899fa64204ea8934af

data/lib/fresh_service/client/v2/group/create.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+module FreshService
+  class Client
+    module V2
+      module Group
+        module Create
+          # Create a group
+          #
+          # @param = [name, description, unassigned_for, agent_ids, members, approval_required]
+          #
+          # @return Faraday Response
+          # @see https://api.freshservice.com/#create_a_group
+          def create_group(options = {})
+            post "/groups", options
+          end
+        end
+      end
+    end
+  end
+end

data/lib/fresh_service/client/v2/group/view.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+module FreshService
+  class Client
+    module V2
+      module Group
+        module View
+          # View a Group
+          #
+          # @param = [group_id]
+          #
+          # @return Faraday Response
+          # @see https://api.freshservice.com/#view_a_group
+          def view_group(group_id, options = {})
+            get "/groups/#{group_id}", options
+          end
+        end
+      end
+    end
+  end
+end

data/lib/fresh_service/client/v2/service_request/create.rb

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+module FreshService
+  class Client
+    module V2
+      module ServiceRequest
+        module Create
+          # Create a ServiceRequest
+          #
+          # @param for service request
+          # | Attribute     | Type   | Description                                                              |
+          # | display_id    | number | Service Item ID inside service catalog                                   |
+          # | quantity      | number | Quantity needed by the requested                                         |
+          # | requested_for | email  | Email id of the requester on whose behalf the service request is created |
+          # | email         | email  | Email id of the requester                                                |
+          # | child_items   | -      | Provide the display id as service_item_id for each child item.           |
+          # | custom_fields | -      | Values of custom fields present in the service item form                 |
+          #
+          # @return Faraday Response
+          # @see https://api.freshservice.com/#create_service_request
+          def create_service_request(display_id, options = {})
+            post "/service_catalog/items/#{display_id}/place_request", options
+          end
+        end
+      end
+    end
+  end
+end

data/lib/fresh_service/client/v2/service_request/update.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+module FreshService
+  class Client
+    module V2
+      module ServiceRequest
+        module Update
+          # Update a ServiceRequest
+          #
+          # @param ServiceRequest update refer create service request
+          #
+          # @return Faraday Response
+          # @see https://api.freshservice.com/#update_req_items_of_sr
+          def update_service_request(ticket_id, item_id, options = {})
+            put "/tickets/#{ticket_id}/requested_items/#{item_id}", options
+          end
+        end
+      end
+    end
+  end
+end

data/lib/fresh_service/client/v2/ticket/create.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+module FreshService
+  class Client
+    module V2
+      module Ticket
+        module Create
+          # Create a ticket
+          #
+          # @param = [name, requester_id, email, phone, subject, type, status, priority, description,
+          #           responder_id, attachments, cc_emails, custom_fields, due_by, email_config_id,
+          #           fr_due_by, group_id, source, tags, department_id, category, sub_category,
+          #           item_category, associate_ci, assets, urgency, impact, problem]
+          #
+          # @return Faraday Response
+          # @see https://api.freshservice.com/#create_ticket
+          def create_ticket(options = {})
+            post "/tickets", options
+          end
+        end
+      end
+    end
+  end
+end

data/lib/fresh_service/client/v2/ticket/update.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+module FreshService
+  class Client
+    module V2
+      module Ticket
+        module Update
+          # Update a ticket
+          #
+          # @param Refer create ticket
+          #
+          # @return Faraday Response
+          # @see https://api.freshservice.com/#update_ticket_priority
+          def update_ticket(ticket_id, options = {})
+            put "/tickets/#{ticket_id}", options
+          end
+        end
+      end
+    end
+  end
+end

data/lib/fresh_service/client/v2/ticket/view.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+module FreshService
+  class Client
+    module V2
+      module Ticket
+        module View
+          # View a ticket
+          #
+          # @param = [ticket_id]
+          #
+          # @return Faraday Response
+          # @see https://api.freshservice.com/#view_a_ticket
+          def view_ticket(ticket_id, options = {})
+            get "/tickets/#{ticket_id}", options
+          end
+        end
+      end
+    end
+  end
+end

data/lib/fresh_service/client.rb

@@ -0,0 +1,40 @@
+# frozen_string_literal: true
+
+require "fresh_service/default"
+require "fresh_service/connection"
+require "fresh_service/configurable"
+require "fresh_service/client/v2/ticket/create"
+require "fresh_service/client/v2/ticket/update"
+require "fresh_service/client/v2/ticket/view"
+require "fresh_service/client/v2/group/create"
+require "fresh_service/client/v2/group/view"
+require "fresh_service/client/v2/service_request/create"
+require "fresh_service/client/v2/service_request/update"
+require "fresh_service/error"
+
+module FreshService
+  # Client for the FreshService API
+  #
+  # @see https://api.freshservice.com/
+  class Client
+    include FreshService::Default
+    include FreshService::Connection
+    include FreshService::Configurable
+    include FreshService::Client::V2::Ticket::Create
+    include FreshService::Client::V2::Ticket::Update
+    include FreshService::Client::V2::Ticket::View
+    include FreshService::Client::V2::Group::Create
+    include FreshService::Client::V2::Group::View
+    include FreshService::Client::V2::ServiceRequest::Create
+    include FreshService::Client::V2::ServiceRequest::Update
+
+    def initialize(options = {})
+      # Use options passed in, but fall back to module defaults
+      FreshService::Configurable.keys.each do |key|
+        value = options.key?(key) ? options[key] : FreshService.instance_variable_get(:"@#{key}")
+        value = value.presence || FreshService::Default.send(:"#{key}")
+        instance_variable_set(:"@#{key}", value)
+      end
+    end
+  end
+end

data/lib/fresh_service/configurable.rb

@@ -0,0 +1,53 @@
+# frozen_string_literal: true
+
+module FreshService
+  # Configuration options for {Client}, defaulting to values
+  # in {Default}
+  module Configurable
+    attr_accessor :organisation, :env, :api_key, :content_type,
+      :api_endpoint, :user_agent
+
+    class << self
+      # List of configurable keys for {FreshService::Client}
+      # @return [Array] of option keys
+      def keys
+        @keys ||= %i[
+          organisation
+          env
+          api_key
+          content_type
+          api_endpoint
+          user_agent
+        ]
+      end
+    end
+
+    # Set configuration options using a block
+    def configure
+      yield self
+    end
+
+    # Reset configuration options to default values
+    def reset!
+      FreshService::Configurable.keys.each do |key|
+        instance_variable_set(:"@#{key}", FreshService::Default.options[key])
+      end
+      self
+    end
+    alias setup reset!
+
+    # Compares client options to a Hash of requested options
+    #
+    # @param opts [Hash] Options to compare with current client options
+    # @return [Boolean]
+    def same_options?(opts)
+      opts.hash == options.hash
+    end
+
+    private
+
+      def options
+        Hash[FreshService::Configurable.keys.map { |key| [key, instance_variable_get(:"@#{key}")] }]
+      end
+  end
+end

data/lib/fresh_service/connection.rb

@@ -0,0 +1,76 @@
+# frozen_string_literal: true
+
+require "json"
+require "addressable/uri"
+require "faraday"
+
+# Network layer for API clients.
+module FreshService
+  module Connection
+    # 408 -> Request Timeout
+    # 502 -> Bad Gateway
+    # 503 -> Service Unavailable
+    # 504 -> Gateway Timeout
+    RETRY_HTTP_CODES = [408, 502, 503, 504].freeze
+
+    # Make a HTTP GET request
+    #
+    # @param url [String] The path, relative to {#api_endpoint}
+    # @param options [Hash] Query and header params for request
+    # @return response body object
+    def get(url, body = {})
+      request :get, url, body
+    end
+
+    # Make a HTTP POST request
+    #
+    # @param url [String] The path, relative to {#api_endpoint}
+    # @param body [Hash] Body for request
+    # @return response body object
+    def post(url, body = {})
+      request :post, url, body
+    end
+
+    # Make a HTTP PUT request
+    #
+    # @param url [String] The path, relative to {#api_endpoint}
+    # @param body [Hash] Body for request
+    # @return response body object
+    def put(url, body = {})
+      request :put, url, body
+    end
+
+    private
+
+      def request(method, path, body = {})
+        agent = setup_connection(path)
+        response = agent.send(method) { |req| req.body = body.to_json }
+        response_body = JSON.parse(response.body)
+
+        if response_body["code"] == "access_denied"
+          raise Error::AuthenticationFailed
+        else
+          response_body
+        end
+      end
+
+      def setup_connection(path)
+        url = Addressable::URI.parse(api_endpoint + path).normalize.to_s
+        @agent = Faraday.new(url) do |req|
+          req.request :basic_auth, api_key, ""
+          req.headers["User-Agent"] = user_agent
+          req.headers["Content-Type"] = content_type
+          req.adapter Faraday.default_adapter
+          req.request :retry, retry_options
+        end
+      end
+
+      def retry_options
+        {
+          max: 3, interval: 0.05,
+          interval_randomness: 0.5, backoff_factor: 2,
+          retry_statuses: RETRY_HTTP_CODES
+        }
+      end
+  end
+end

data/lib/fresh_service/default.rb

@@ -0,0 +1,58 @@
+# frozen_string_literal: true
+
+require "fresh_service/version"
+
+module FreshService
+  # Default configuration options for {Client}
+  module Default
+    class << self
+      # Configuration options
+      # @return [Hash]
+      def options
+        Hash[FreshService::Configurable.keys.map { |key| [key, send(key)] }]
+      end
+
+      # Default FreshService api_key from ENV
+      # @return [String]
+      def api_key
+        ENV["FRESH_SERVICE_API_KEY"]
+      end
+
+      # Default ENV
+      # @return [String]
+      def env
+        Rails.env
+      rescue StandardError
+        "development"
+      end
+
+      # Default BASE PACKAGE_URL
+      # @return [String]
+      def api_version_url
+        "api/v2"
+      end
+
+      # Default user_agent
+      # @return [String]
+      def user_agent
+        "fresh-service-#{FreshService::VERSION}"
+      end
+
+      # Default api_endpoint FreshService URL for company
+      # @return [String]
+      def api_endpoint
+        "https://#{organisation}.freshservice.com/#{api_version_url}"
+      end
+
+      # Default HTTP content_type
+      # @return [String]
+      def content_type
+        "application/json"
+      end
+
+      def organisation
+        ENV["FRESH_SERVICE_ORG"]
+      end
+    end
+  end
+end

data/lib/fresh_service/error.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module FreshService
+  class Error < StandardError
+    class AuthenticationFailed < self; end
+  end
+end

data/lib/fresh_service/version.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+module FreshService
+  # Current major release.
+  # @return [Integer]
+  MAJOR = 1
+
+  # Current minor release.
+  # @return [Integer]
+  MINOR = 0
+
+  # Current patch level.
+  # @return [Integer]
+  PATCH = 0
+
+  # Full release version.
+  # @return [String]
+  VERSION = [MAJOR, MINOR, PATCH].join(".").freeze
+end

data/lib/fresh_service.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+require "fresh_service/client"
+require "fresh_service/default"
+
+# Ruby toolkit for the FreshService API
+module FreshService
+  class << self
+    include FreshService::Configurable
+
+    # API client based on configured options {Configurable}
+    #
+    # @return [FreshService::Client] API wrapper
+    def client
+      return @client if defined?(@client) && @client.same_options?(options)
+
+      @client = FreshService::Client.new(options)
+    end
+  end
+end
+
+FreshService.setup

metadata

@@ -0,0 +1,211 @@
+--- !ruby/object:Gem::Specification
+name: fresh_service_api_v2_client
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Vikas Prasad
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2022-08-13 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: addressable
+  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: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.2.10
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.2.10
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  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: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.14.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.14.0
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.2.7
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.2.7
+- !ruby/object:Gem::Dependency
+  name: faraday
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.17.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.17.0
+- !ruby/object:Gem::Dependency
+  name: faraday_middleware
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.11.0.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.11.0.1
+- !ruby/object:Gem::Dependency
+  name: byebug
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 11.1.3
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 11.1.3
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.10'
+- !ruby/object:Gem::Dependency
+  name: rubocop-rails
+  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'
+description: Simple wrapper for the FreshService API
+email:
+- vikas95prasad@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/fresh_service.rb
+- lib/fresh_service/client.rb
+- lib/fresh_service/client/v2/group/create.rb
+- lib/fresh_service/client/v2/group/view.rb
+- lib/fresh_service/client/v2/service_request/create.rb
+- lib/fresh_service/client/v2/service_request/update.rb
+- lib/fresh_service/client/v2/ticket/create.rb
+- lib/fresh_service/client/v2/ticket/update.rb
+- lib/fresh_service/client/v2/ticket/view.rb
+- lib/fresh_service/configurable.rb
+- lib/fresh_service/connection.rb
+- lib/fresh_service/default.rb
+- lib/fresh_service/error.rb
+- lib/fresh_service/version.rb
+homepage: https://rubygems.org/gems/fresh_service_api_v2_client
+licenses:
+- MIT
+metadata: {}
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.6.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 1.3.5
+requirements: []
+rubygems_version: 3.1.6
+signing_key:
+specification_version: 4
+summary: Ruby toolkit for working with the Fresh Service API v2
+test_files: []