linkedin-api 0.8.9

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 93d087170b8192f65f736e4c4372591df800da4e41fff2dde3e33673cc3e364a
+  data.tar.gz: a40a61cabd1006e165050c547713912779f1ac8b7d76f8432e2a14dc4f6a9b5a
+SHA512:
+  metadata.gz: 41eecf64b4c967af66c5275d941c3c6912efe496fd2edbd1ba5dbe2e4b3f4935eaa3fddd7bf37c2a43d63dc63f57de8f570d7824aa8ce5ccfd358c2419453d7a
+  data.tar.gz: 01e4686bac59ccaa6ef956110801fcbc3bfc0d1b319b9d3033efe019674a59a81bbc7f96a58a398cd61c2131bfd866ececc03d7f43d767d06968d0fe3ee73793

data/lib/linked_in/api/current_user.rb

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+module LinkedIn
+  module API
+    class CurrentUser
+      attr_reader :client
+
+      LOCATION_URN_PREFIX = 'urn:li:standardizedLocationKey'
+
+      def initialize(client)
+        @client = client
+      end
+
+      def me
+        client.get('v2/me', projection: '(*,profilePicture(displayImage~:playableStreams))')
+      end
+
+      def email
+        client.get('v2/emailAddress', q: 'members', projection: '(elements*(handle~))')
+      end
+
+      def location(urn)
+        return unless urn.start_with?(LOCATION_URN_PREFIX)
+
+        client.get('v2/regions', q: 'standardizedLocation', standardizedLocation: urn)
+      end
+    end
+  end
+end

data/lib/linked_in/api/media.rb

@@ -0,0 +1,44 @@
+# frozen_string_literal: true
+
+require 'open-uri'
+
+module LinkedIn
+  module API
+    class Media
+      TYPES = { 'image/png': '.png', 'image/jpeg': '.jpeg' }.freeze
+      attr_reader :client
+
+      def initialize(client)
+        @client = client
+      end
+
+      def upload(image_url, organization_id)
+        image = URI.open(image_url)
+        type = image.content_type
+        raise "Unexpected content type: '#{type}'" unless TYPES.key?(type.to_sym)
+
+        response = image_register(organization_id)
+        client.media_upload(response[:uploadUrl], image, filename(image))
+        response
+      end
+
+      private
+
+      def image_register(organization_id)
+        body = {
+          initializeUploadRequest: {
+            owner: "urn:li:organization:#{organization_id}",
+          },
+        }
+        response = client.post('rest/images?action=initializeUpload', body)
+        response.dig(:value)
+      end
+
+      def filename(media)
+        filename = File.basename(media.base_uri.to_s)
+        filename += TYPES[media.content_type.to_sym] unless filename.match?('\.(jpg|jpeg|png)')
+        filename
+      end
+    end
+  end
+end

data/lib/linked_in/api/organization.rb

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+module LinkedIn
+  module API
+    class Organization
+      attr_reader :client
+
+      def initialize(client)
+        @client = client
+      end
+
+      def organizations
+        client.get('rest/organizationAcls?q=roleAssignee&count=50')
+      end
+
+      def organization(id)
+        client.get("rest/organizations/#{id}")
+      end
+
+      def organization_statistics(urn)
+        client.get("rest/organizationalEntityShareStatistics?q=organizationalEntity&organizationalEntity=#{urn}")
+      end
+
+      def organization_network_size(id)
+        client.get("rest/networkSizes/urn:li:organization:#{id}", edgeType: 'COMPANY_FOLLOWED_BY_MEMBER')
+      end
+    end
+  end
+end

data/lib/linked_in/api/post.rb

@@ -0,0 +1,112 @@
+# frozen_string_literal: true
+
+module LinkedIn
+  module API
+    class Post
+      attr_reader :client, :media, :logger
+
+      def initialize(client, media, logger=nil)
+        @client = client
+        @media = media
+        @logger = logger
+      end
+
+      def create(organization_id, share_data)
+        share = Hashie::Mash.new(share_data)
+        post = create_post(content(share, organization_id), organization_id).to_json
+        client.post('rest/posts', post)
+      end
+
+      def social_summary(id)
+        get_post_summary(id)
+      end
+
+      def likes_summary(id)
+        get_post_summary(id, '(likesSummary)')
+      end
+
+      def comments_summary(id)
+        get_post_summary(id, '(commentsSummary)')
+      end
+
+      private
+
+      def content(share, organization_id)
+        comment = comment_content(share.comment)
+        content = image_content(share.content, organization_id) || {}
+        compact(comment.deep_merge!(content))
+      end
+
+      def create_post(content, organization_id)
+        payload = Hashie::Mash.new(
+          author: "urn:li:organization:#{organization_id}",
+          lifecycleState: 'PUBLISHED',
+          visibility: 'PUBLIC',
+          isReshareDisabledByAuthor: false,
+          distribution: {
+            feedDistribution: "MAIN_FEED",
+            targetEntities: [],
+            thirdPartyDistributionChannels: [],
+          },
+        ).deep_merge!(content)
+
+        logger&.debug(msg: "## PAYLOAD -> ", payload: payload.to_json)
+        payload
+      end
+
+      def comment_content(comment)
+        Hashie::Mash.new(
+          commentary: escape_characters(comment)
+        )
+      end
+
+      ##
+      # The api from 2023-02 has some special characters and underscore is one of them that not works as expected on links
+      #
+      # @link https://learn.microsoft.com/en-us/linkedin/marketing/integrations/community-management/shares/little-text-format?view=li-lms-2023-02#text
+      #
+      #
+      def escape_characters(comment)
+        replacements = {
+          '_' => '\\_',
+          '~' => '\\~',
+          '*' => '\\*',
+          '[' => '\\[',
+          ']' => '\\]',
+          '(' => '\\(',
+          ')' => '\\)',
+          '{' => '\\{',
+          '}' => '\\}',
+          '|' => '\\|',
+          '#' => '\\#',
+          '@' => '\\@',
+          '>' => '\\>',
+          '<' => '\\<',
+          '\\' => '\\\\'
+        }
+        comment.to_s.gsub(/[\_\~\*\[\]\(\)\{\}\|\#\@\>\<\\]/, replacements)
+      end
+
+      def image_content(content, organization_id)
+        image_url = content&.dig(:"submitted-image-url") || ''
+        return if image_url.empty?
+
+        image = @media.upload(image_url, organization_id)
+        {
+          content: {
+            media: compact(id: image[:image]),
+          },
+        }
+      end
+
+      def compact(hash)
+        hash.delete_if { |_k, value| value.is_a?(Hash) ? compact(value).empty? : value.nil? }
+      end
+
+      def get_post_summary(id, projection = {})
+        options = { projection: projection } unless projection.empty?
+        client.get("v2/socialActions/" + URI.encode_www_form_component("urn:li:share:#{id}"), options || {})
+      end
+    end
+  end
+end

data/lib/linked_in/auth/access_token.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module LinkedIn
+  module Auth
+    class AccessToken
+      attr_reader :token, :expires_in
+
+      def initialize(attrs = {})
+        @token = attrs.delete('access_token')
+        @expires_in = attrs.delete('expires_in')
+      end
+    end
+  end
+end

data/lib/linked_in/auth/client.rb

@@ -0,0 +1,64 @@
+# frozen_string_literal: true
+
+require 'faraday'
+require 'securerandom'
+require 'faraday_middleware'
+
+require 'linked_in/middleware/raise_error'
+require 'linked_in/auth/access_token'
+
+module LinkedIn
+  module Auth
+    class Client
+      def initialize(state = SecureRandom.hex, config = LinkedIn.config)
+        @state = state
+        @config = config
+      end
+
+      def authorize_url
+        params = authorize_url_params.merge(state: @state)
+        connection.build_url(config.authorize_url, params).to_s
+      end
+
+      def access_token(code, state = nil)
+        raise LinkedIn::InvalidRequestError if code.nil?
+
+        params = access_token_params.merge(code: code, state: state)
+        response = connection.post(config.token_url, params)
+
+        Auth::AccessToken.new(response.body)
+      end
+
+      private
+
+      attr_reader :config
+
+      def connection
+        @connection ||= Faraday.new(config.site) do |conn|
+          conn.use LinkedIn::Middleware::RaiseError
+          conn.request :url_encoded
+          conn.response :json, content_type: /\bjson$/
+          conn.adapter Faraday.default_adapter
+        end
+      end
+
+      def authorize_url_params
+        {
+          scope: config.scope,
+          response_type: :code,
+          client_id: config.client_id,
+          redirect_uri: config.redirect_uri,
+        }
+      end
+
+      def access_token_params
+        {
+          client_id: config.client_id,
+          client_secret: config.client_secret,
+          redirect_uri: config.redirect_uri,
+          grant_type: :authorization_code,
+        }
+      end
+    end
+  end
+end

data/lib/linked_in/configuration.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+module LinkedIn
+  class Configuration
+    FIELDS = {
+      site: 'https://www.linkedin.com',
+      scope: nil,
+      client_id: nil,
+      client_secret: nil,
+      redirect_uri: nil,
+      token_url: '/oauth/v2/accessToken',
+      authorize_url: '/oauth/v2/authorization',
+    }.freeze
+
+    FIELDS.each do |name, default_value|
+      define_method(name) do
+        instance_variable_get("@#{name}") || default_value
+      end
+
+      define_method("#{name}=") do |value|
+        instance_variable_set("@#{name}", value)
+      end
+    end
+  end
+end

data/lib/linked_in/errors.rb

@@ -0,0 +1,43 @@
+# frozen_string_literal: true
+
+module LinkedIn
+  class APIError < RuntimeError
+    def initialize(response = nil)
+      @response = response
+    end
+
+    def http_status
+      response&.status
+    end
+
+    def http_headers
+      response&.headers
+    end
+
+    def http_body
+      response&.body
+    end
+
+    def message
+      return super() unless response
+
+      "#{self.class} - #{http_status}: #{http_body}"
+    end
+
+    private
+
+    attr_reader :response
+  end
+
+  class InvalidRequestError < APIError; end
+
+  class UnauthorizedError < APIError; end
+
+  class AccessDeniedError < APIError; end
+
+  class NotFoundError < APIError; end
+
+  class InformLinkedInError < APIError; end
+
+  class UnavailableError < APIError; end
+end

data/lib/linked_in/http_client.rb

@@ -0,0 +1,85 @@
+# frozen_string_literal: true
+
+require 'faraday'
+require 'faraday_middleware'
+require 'linked_in/middleware/raise_error'
+
+module LinkedIn
+  class HTTPClient
+    BASE_URL = 'https://api.linkedin.com/'
+    LINKEDIN_VERSION_API = '202511'
+    HEADER_RESTLI_PROTOCOL = '2.0.0'
+
+    attr_reader :json_client, :multipart_client, :protocol, :debug_mode
+
+    def initialize(access_token:, protocol: true, debug_mode: false)
+      @protocol = protocol
+      @json_client = build_client(access_token, BASE_URL, :json)
+      @multipart_client = build_client(access_token, BASE_URL, :multipart)
+      @debug_mode = debug_mode
+    end
+
+    def get(path, params = {}, headers = {})
+      response = json_client.get(path, params, headers)
+      to_result(response)
+    end
+
+    def post(path, body = {})
+      response = json_client.post(path, body)
+      to_result(response)
+    end
+
+    def register_upload(path, body)
+      post(path, body)
+    end
+
+    def media_upload(path, media, filename)
+      header_media_content(multipart_client, media)
+      content = Faraday::UploadIO.new(media, media.content_type, filename)
+
+      response = multipart_client.put(path, content)
+      response
+    end
+
+    private
+
+    def header_media_content(client, media)
+      client.headers["Content-Type"] = media.content_type
+      client.headers['Content-Length'] = media.length.to_s
+    end
+
+    def to_result(response)
+      unless response.body.empty?
+        body = response.body.is_a?(Hash) ? response.body : JSON.parse(response.body)
+
+        return Hashie::Mash.new(response.body)
+      end
+
+      Hashie::Mash.new(
+        'id': response.headers['x-restli-id'],
+        'x-li-uuid': response.headers['x-li-uuid']
+      )
+    end
+
+    def build_client(access_token, url, type)
+      Faraday.new(url: url) do |builder|
+        builder.authorization('Bearer', access_token)
+        builder.request type
+        builder.use Faraday::Request::UrlEncoded
+        builder.use LinkedIn::Middleware::RaiseError
+        builder.use FaradayMiddleware::ParseJson, content_type: /\bjson$/
+        builder.adapter :net_http
+
+        # @link https://learn.microsoft.com/en-us/linkedin/marketing/versioning?view=li-lms-unversioned
+        builder.headers['LinkedIn-Version'] = LINKEDIN_VERSION_API
+        builder.headers['X-Restli-Protocol-Version'] = HEADER_RESTLI_PROTOCOL if protocol?
+
+        builder.response :logger, nil, { headers: true, bodies: true, errors: true }
+      end
+    end
+
+    def protocol?
+      protocol
+    end
+  end
+end

data/lib/linked_in/middleware/raise_error.rb

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+require 'linked_in/errors'
+
+# rubocop:disable Metrics/CyclomaticComplexity
+module LinkedIn
+  module Middleware
+    class RaiseError < Faraday::Response::RaiseError
+      def on_complete(env)
+        response = env.response
+        case response.status
+        when 400
+          raise LinkedIn::InvalidRequestError, response
+        when 401
+          raise LinkedIn::UnauthorizedError, response
+        when 403
+          raise LinkedIn::AccessDeniedError, response
+        when 404
+          raise LinkedIn::NotFoundError, response
+        when 500
+          raise LinkedIn::InformLinkedInError, response
+        when 502..503
+          raise LinkedIn::UnavailableError, response
+        else
+          super
+        end
+      end
+    end
+  end
+end

data/lib/linked_in/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module LinkedIn
+  VERSION = '0.8.9'
+end

data/lib/linked_in.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+require 'hashie'
+require 'linked_in/version'
+require 'linked_in/http_client'
+require 'linked_in/auth/client'
+require 'linked_in/api/organization'
+require 'linked_in/api/media'
+require 'linked_in/api/post'
+require 'linked_in/api/current_user'
+require 'linked_in/configuration'
+
+module LinkedIn
+  class << self
+    def setup
+      yield config
+    end
+
+    def config
+      @config ||= Configuration.new
+    end
+  end
+end

metadata

@@ -0,0 +1,137 @@
+--- !ruby/object:Gem::Specification
+name: linkedin-api
+version: !ruby/object:Gem::Version
+  version: 0.8.9
+platform: ruby
+authors:
+- LeadGen Team
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2025-12-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: faraday
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0.17'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0.17'
+- !ruby/object:Gem::Dependency
+  name: faraday_middleware
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0.13'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0.13'
+- !ruby/object:Gem::Dependency
+  name: hashie
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.5'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.5'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  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: rexml
+  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: A gem to use LinkedIn API
+email: leadgen@resultadosdigitais.com.br
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/linked_in.rb
+- lib/linked_in/api/current_user.rb
+- lib/linked_in/api/media.rb
+- lib/linked_in/api/organization.rb
+- lib/linked_in/api/post.rb
+- lib/linked_in/auth/access_token.rb
+- lib/linked_in/auth/client.rb
+- lib/linked_in/configuration.rb
+- lib/linked_in/errors.rb
+- lib/linked_in/http_client.rb
+- lib/linked_in/middleware/raise_error.rb
+- lib/linked_in/version.rb
+homepage: https://github.com/ResultadosDigitais/linkedin
+licenses: []
+metadata: {}
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '3.0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.4.20
+signing_key:
+specification_version: 4
+summary: A gem to use LinkedIn API
+test_files: []