roseflow-proxycurl 0.5.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 3c7ca7800c548f6ce3653f6293ddb1f594c88e4a1917f79fb2c7e514450e853d
+  data.tar.gz: b958674834ce20eff5469ed53e319840c313fcaf96c2d11cabd83f644a273c38
+SHA512:
+  metadata.gz: 9dbe708e052754805a27d5d144005e55694361b52a8e943f09f6861ace517fd7cb72778720f98527ec54843cbb888d60a9b9edafb788618a04d21cd585139fae
+  data.tar.gz: a53ac1c72f93c32a5dedc529786eba92d49ec5339c2fcbfae437b32592f42a2ae570dcdb84ac4ca407823e7dda06819ed7011a9f78bfbeaa24d1c84958a7ff4e

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.standard.yml

@@ -0,0 +1,3 @@
+# For available configuration options, see:
+#   https://github.com/testdouble/standard
+ruby_version: 2.6

data/CHANGELOG.md

@@ -0,0 +1,10 @@
+## [0.5.0] - 2023-05-18
+
+- Initial release
+- Implements [Company Profile endpoint](https://nubela.co/proxycurl/docs#company-api-company-profile-endpoint)
+- Implements [Company Lookup endpoint](https://nubela.co/proxycurl/docs#company-api-company-lookup-endpoint)
+- Implements [Person Profile endpoint](https://nubela.co/proxycurl/docs#people-api-person-profile-endpoint)
+- Implements [Person Role Lookup endpoint](https://nubela.co/proxycurl/docs#people-api-role-lookup-endpoint)
+- Implements [Person Lookup endpoint](https://nubela.co/proxycurl/docs#people-api-person-lookup-endpoint)
+- Implements [Job Profile endpoint](https://nubela.co/proxycurl/docs#jobs-api-job-profile-endpoint)
+- Implements [Job Search endpoint](https://nubela.co/proxycurl/docs#jobs-api-job-search-endpoint)

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,84 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+We as members, contributors, and leaders pledge to make participation in our community a harassment-free experience for everyone, regardless of age, body size, visible or invisible disability, ethnicity, sex characteristics, gender identity and expression, level of experience, education, socio-economic status, nationality, personal appearance, race, religion, or sexual identity and orientation.
+
+We pledge to act and interact in ways that contribute to an open, welcoming, diverse, inclusive, and healthy community.
+
+## Our Standards
+
+Examples of behavior that contributes to a positive environment for our community include:
+
+* Demonstrating empathy and kindness toward other people
+* Being respectful of differing opinions, viewpoints, and experiences
+* Giving and gracefully accepting constructive feedback
+* Accepting responsibility and apologizing to those affected by our mistakes, and learning from the experience
+* Focusing on what is best not just for us as individuals, but for the overall community
+
+Examples of unacceptable behavior include:
+
+* The use of sexualized language or imagery, and sexual attention or
+  advances of any kind
+* Trolling, insulting or derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or email
+  address, without their explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Enforcement Responsibilities
+
+Community leaders are responsible for clarifying and enforcing our standards of acceptable behavior and will take appropriate and fair corrective action in response to any behavior that they deem inappropriate, threatening, offensive, or harmful.
+
+Community leaders have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, and will communicate reasons for moderation decisions when appropriate.
+
+## Scope
+
+This Code of Conduct applies within all community spaces, and also applies when an individual is officially representing the community in public spaces. Examples of representing our community include using an official e-mail address, posting via an official social media account, or acting as an appointed representative at an online or offline event.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported to the community leaders responsible for enforcement at git@laurijutila.com. All complaints will be reviewed and investigated promptly and fairly.
+
+All community leaders are obligated to respect the privacy and security of the reporter of any incident.
+
+## Enforcement Guidelines
+
+Community leaders will follow these Community Impact Guidelines in determining the consequences for any action they deem in violation of this Code of Conduct:
+
+### 1. Correction
+
+**Community Impact**: Use of inappropriate language or other behavior deemed unprofessional or unwelcome in the community.
+
+**Consequence**: A private, written warning from community leaders, providing clarity around the nature of the violation and an explanation of why the behavior was inappropriate. A public apology may be requested.
+
+### 2. Warning
+
+**Community Impact**: A violation through a single incident or series of actions.
+
+**Consequence**: A warning with consequences for continued behavior. No interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, for a specified period of time. This includes avoiding interactions in community spaces as well as external channels like social media. Violating these terms may lead to a temporary or permanent ban.
+
+### 3. Temporary Ban
+
+**Community Impact**: A serious violation of community standards, including sustained inappropriate behavior.
+
+**Consequence**: A temporary ban from any sort of interaction or public communication with the community for a specified period of time. No public or private interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, is allowed during this period. Violating these terms may lead to a permanent ban.
+
+### 4. Permanent Ban
+
+**Community Impact**: Demonstrating a pattern of violation of community standards, including sustained inappropriate behavior,  harassment of an individual, or aggression toward or disparagement of classes of individuals.
+
+**Consequence**: A permanent ban from any sort of public interaction within the community.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 2.0,
+available at https://www.contributor-covenant.org/version/2/0/code_of_conduct.html.
+
+Community Impact Guidelines were inspired by [Mozilla's code of conduct enforcement ladder](https://github.com/mozilla/diversity).
+
+[homepage]: https://www.contributor-covenant.org
+
+For answers to common questions about this code of conduct, see the FAQ at
+https://www.contributor-covenant.org/faq. Translations are available at https://www.contributor-covenant.org/translations.

data/Gemfile

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in roseflow-proxycurl.gemspec
+gemspec
+
+gem "rake", "~> 13.0"
+
+gem "rspec", "~> 3.0"
+
+gem "standard", "~> 1.3"

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2023 Lauri Jutila
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,49 @@
+# Proxycurl API support for Roseflow
+
+This gem adds Proxycurl API support for Roseflow, making it easy to find people and businesses from LinkedIn.
+
+## What is Proxycurl?
+
+Proxycurl is an enrichment API to fetch fresh data on people and businesses from LinkedIn.
+
+Visit [Proxycurl's website](https://nubela.co/proxycurl) to learn more.
+
+## Installation
+
+Install the gem and add to the application's Gemfile by executing:
+
+    $ bundle add roseflow-proxycurl
+
+If bundler is not being used to manage dependencies, install the gem by executing:
+
+    $ gem install roseflow-proxycurl
+
+## Usage
+
+See full documentation how to configure and use Proxycurl APIs with Roseflow at [docs.roseflow.ai](https://docs.roseflow.ai/support/proxycurl).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/roseflow-ai/roseflow-proxycurl.
+
+## Community
+
+### Discord
+
+Join us in our [Discord](https://discord.gg/roseflow).
+
+### Twitter
+
+Connect with the core team on Twitter.
+
+<a href="https://twitter.com/ljuti" target="_blank">
+  <img alt="Twitter Follow" src="https://img.shields.io/twitter/follow/ljuti?logo=twitter&style=social">
+</a>
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the `roseflow-proxycurl` project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://roseflow.ai/conduct).

data/Rakefile

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+require "standard/rake"
+
+task default: %i[spec standard]

data/lib/roseflow/linkedin/company/lookup_query.rb

@@ -0,0 +1,58 @@
+# frozen_string_literal: true
+
+require "dry-validation"
+require "roseflow/proxycurl/object"
+require "roseflow/linkedin/company"
+require "roseflow/types"
+
+module Roseflow
+  module LinkedIn
+    class Company
+    end
+
+    class Company::LookupQuery < Proxycurl::ProxycurlObject
+      class LookupQueryContract < Dry::Validation::Contract
+        params do
+          optional(:domain).filled(:string)
+          optional(:name).filled(:string)
+          optional(:location).filled(:string)
+          optional(:enrich).filled(:bool)
+        end
+
+        rule(:domain, :name) do
+          unless values[:domain] || values[:name]
+            key.failure("must provide either company domain or company name")
+          end
+        end
+      end
+
+      contract_object LookupQueryContract
+
+      schema schema.strict
+
+      attribute? :domain, Types::String
+      attribute? :name, Types::String
+      attribute? :location, Types::String
+      attribute? :enrich, Types::Bool.default(false)
+
+      def self.new(input)
+        validation = self.contract_object.new.call(input)
+        raise ArgumentError, validation.errors.to_h.inspect unless validation.success?
+        super(input)
+      end
+
+      def to_request_params
+        params = {
+          company_domain: domain,
+          company_name: name,
+          company_location: location,
+          enrich_profile: enrich,
+        }
+
+        params.each_pair do |key, value|
+          params.delete(key) unless value
+        end
+      end
+    end
+  end
+end

data/lib/roseflow/linkedin/company/object.rb

@@ -0,0 +1,82 @@
+# frozen_string_literal: true
+
+require "dry-transformer"
+
+module Roseflow
+  module LinkedIn
+    module CompanyTransformations
+      extend Dry::Transformer::Registry
+
+      import Dry::Transformer::ArrayTransformations
+      import Dry::Transformer::HashTransformations
+
+      rename_keys = t(:map_keys, linkedin_internal_id: :id, universal_name_id: :shorthand)
+
+      # Transformation = t(:compose, t(:symbolize_keys), rename_keys)
+    end
+
+    class CompanyMapper < Dry::Transformer::Pipe
+      import Dry::Transformer::HashTransformations
+
+      define! do
+        symbolize_keys
+        rename_keys linkedin_internal_id: :id, universal_name_id: :shorthand, website: :url
+      end
+    end
+
+    class Company
+      class Object < Dry::Struct
+        defines :contract_object
+
+        class CompanyContract < Dry::Validation::Contract
+          params do
+            required(:id).filled(:string)
+            required(:name).filled(:string)
+            required(:profile_url).filled(:string)
+            required(:url).filled(:string)
+            required(:shorthand).filled(:string)
+            required(:tagline).filled(:string)
+            required(:description).filled(:string)
+            required(:industry).filled(:string)
+            required(:company_type).filled(:string)
+            required(:locations).array(:hash) do
+              required(:country).filled(:string)
+              required(:city).filled(:string)
+              required(:is_hq).filled(:bool)
+            end
+          end
+
+          def call(input)
+            transformed = CompanyMapper.new.call(input)
+            super(transformed)
+          end
+        end
+
+        attribute :id, Types::String
+        attribute :name, Types::String
+        attribute :profile_url, Types::String
+        attribute :url, Types::String
+        attribute :shorthand, Types::String
+        attribute :tagline, Types::String
+        attribute :description, Types::String
+        attribute :industry, Types::String
+        attribute :company_type, Types::String
+        attribute :locations, Types::Array do
+          attribute :country, Types::String
+          attribute :city, Types::String
+          attribute :is_hq, Types::Bool
+        end
+
+        contract_object CompanyContract
+
+        schema schema.strict
+
+        def self.new(input)
+          validation = self.contract_object.new.call(input)
+          raise ArgumentError, validation.errors.to_h.inspect unless validation.success?
+          super(validation.to_h)
+        end
+      end
+    end
+  end
+end

data/lib/roseflow/linkedin/company/profile_query.rb

@@ -0,0 +1,50 @@
+# frozen_string_literal: true
+
+require "dry-validation"
+require "roseflow/proxycurl/object"
+require "roseflow/linkedin/company"
+require "roseflow/types"
+
+module Roseflow
+  module LinkedIn
+    class Company
+    end
+
+    class Company::ProfileQuery < Proxycurl::ProxycurlObject
+      class ProfileQueryContract < Dry::Validation::Contract
+        params do
+          required(:url).filled(:string)
+        end
+
+        rule (:url) do
+          unless URI.parse(value).is_a?(URI::HTTP)
+            key.failure("must be a valid URL")
+          end
+
+          unless value.match?(/linkedin\.com\/company\/\w+/)
+            key.failure("must be a valid LinkedIn company URL")
+          end
+        end
+      end
+
+      contract_object ProfileQueryContract
+
+      schema schema.strict
+
+      attribute :url, Types::String
+      attribute :resolve_numeric_id, Types::Bool.default(false)
+      attribute :categories, Types::String.default("exclude")
+      attribute :funding_data, Types::String.default("exclude")
+      attribute :extra, Types::String.default("exclude")
+      attribute :exit_data, Types::String.default("exclude")
+      attribute :acquisitions, Types::String.default("exclude")
+      attribute :use_cache, Types::String.default("if-present")
+
+      def self.new(input)
+        validation = self.contract_object.new.call(input)
+        raise ArgumentError, validation.errors.to_h.inspect unless validation.success?
+        super(input)
+      end
+    end
+  end
+end

data/lib/roseflow/linkedin/company.rb

@@ -0,0 +1,38 @@
+# frozen_string_literal: true
+
+require "roseflow/linkedin/company/profile_query"
+require "roseflow/linkedin/company/lookup_query"
+
+module Roseflow
+  module LinkedIn
+    class Company
+      def initialize(connection)
+        @connection = connection
+      end
+
+      def find(url, **options)
+        query = ProfileQuery.new(url: url, **options)
+        response = @connection.get("linkedin/company", query.to_h)
+        return Company::Object.new(JSON.parse(response.body).merge("profile_url" => url)) if company_found?(response)
+        return nil if company_not_found?(response)
+      end
+
+      def lookup(query)
+        query = LookupQuery.new(query)
+        response = @connection.get("linkedin/company/resolve", query.to_request_params)
+        return JSON.parse(response.body).dig("url") if company_found?(response)
+        return nil if company_not_found?(response)
+      end
+
+      private
+
+      def company_found?(response)
+        response.success? && response.status == 200
+      end
+
+      def company_not_found?(response)
+        response.success? && response.status == 404
+      end
+    end
+  end
+end

data/lib/roseflow/linkedin/job/object.rb

@@ -0,0 +1,77 @@
+# frozen_string_literal: true
+
+require "dry-struct"
+require "dry-validation"
+require "dry-transformer"
+require "roseflow/types"
+
+module Roseflow
+  module LinkedIn
+    class Job
+      class Object < Dry::Struct
+        class Company < Dry::Struct
+          transform_keys(&:to_sym)
+
+          attribute :name, Types::String
+          attribute :url, Types::String
+        end
+
+        class Location < Dry::Struct
+          transform_keys(&:to_sym)
+
+          attribute :country, Types::String
+          attribute :city, Types::String
+          attribute :region, Types::String.optional
+        end
+
+        class JobMapper < Dry::Transformer::Pipe
+          import Dry::Transformer::HashTransformations
+
+          define! do
+            deep_symbolize_keys
+            rename_keys linkedin_internal_id: :id, industry: :industries, job_description: :description
+          end
+        end
+
+        defines :contract_object
+
+        class JobContract < Dry::Validation::Contract
+          params do
+            required(:id).filled(:string)
+            required(:title).filled(:string)
+            required(:description).filled(:string)
+            required(:location)
+            required(:company)
+            required(:seniority_level).filled(:string)
+            required(:employment_type).filled(:string)
+            required(:industries).filled(:array)
+          end
+
+          def call(input)
+            transformed = JobMapper.new.call(input)
+            super(transformed)
+          end
+        end
+
+        contract_object JobContract
+
+        schema schema.strict
+
+        attribute :id, Types::String
+        attribute :title, Types::String
+        attribute :description, Types::String
+        attribute :location, Location
+        attribute :company, Company
+        attribute :seniority_level, Types::String
+        attribute :employment_type, Types::String
+        attribute :industries, Types::Array
+
+        def self.new(input)
+          validation = self.contract_object.new.call(input)
+          raise ArgumentError, validation.errors.to_h.inspect unless validation.success?
+          super(validation.to_h)
+        end
+      end
+    end
+  end
+end

data/lib/roseflow/linkedin/job/profile_query.rb

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+require "dry-validation"
+require "roseflow/proxycurl/object"
+require "roseflow/linkedin/job"
+require "roseflow/types"
+
+module Roseflow
+  module LinkedIn
+    class Job
+      class ProfileQuery < Proxycurl::ProxycurlObject
+        class ProfileQueryContract < Dry::Validation::Contract
+          params do
+            required(:url).filled(:string)
+          end
+        end
+
+        contract_object ProfileQueryContract
+
+        schema schema.strict
+
+        attribute :url, Types::String
+
+        def self.new(input)
+          validation = self.contract_object.new.call(input)
+          raise ArgumentError, validation.errors.to_h.inspect unless validation.success?
+          super(input)
+        end
+      end
+    end
+  end
+end

data/lib/roseflow/linkedin/job/search_query.rb

@@ -0,0 +1,48 @@
+# frozen_string_literal: true
+
+require "dry-validation"
+require "roseflow/proxycurl/object"
+require "roseflow/linkedin/job"
+require "roseflow/types"
+
+module Roseflow
+  module LinkedIn
+    class Job
+      class SearchQuery < Proxycurl::ProxycurlObject
+        class SearchQueryContract < Dry::Validation::Contract
+          params do
+            optional(:keyword).filled(:string)
+            optional(:geo_id).filled(:integer)
+            optional(:search_id).filled(:string)
+            optional(:flexibility).filled(:string)
+            optional(:experience_level).filled(:string)
+            optional(:job_type).filled(:string)
+            optional(:when).filled(:string)
+          end
+        end
+
+        contract_object SearchQueryContract
+
+        schema schema.strict
+
+        attribute? :keyword, Types::String
+        attribute? :geo_id, Types::Integer.default(92000000)
+        attribute? :search_id, Types::String
+        attribute? :flexibility, Types::String.default("anything")
+        attribute? :experience_level, Types::String.default("anything")
+        attribute? :job_type, Types::String.default("anything")
+        attribute? :when, Types::String.default("anytime")
+
+        def self.new(input)
+          validation = self.contract_object.new.call(input)
+          raise ArgumentError, validation.errors.to_h.inspect unless validation.success?
+          super(input)
+        end
+
+        def to_request_params
+          to_h
+        end
+      end
+    end
+  end
+end

data/lib/roseflow/linkedin/job.rb

@@ -0,0 +1,38 @@
+# frozen_string_literal: true
+
+require "roseflow/linkedin/job/profile_query"
+require "roseflow/linkedin/job/search_query"
+require "roseflow/linkedin/job_list_entry"
+
+module Roseflow
+  module LinkedIn
+    class Job
+      def initialize(connection)
+        @connection = connection
+      end
+
+      def find(url, **options)
+        query = ProfileQuery.new(url: url, **options)
+        response = @connection.get("linkedin/job", query.to_h)
+        return Job::Object.new(JSON.parse(response.body).merge(url: url)) if job_found?(response)
+        return nil if job_not_found?(response)
+      end
+
+      def search(query)
+        query = SearchQuery.new(query)
+        response = @connection.get("v2/linkedin/company/job", query.to_request_params)
+        return JobListEntry.from(JSON.parse(response.body)) if job_found?(response)
+      end
+
+      private
+
+      def job_found?(response)
+        response.success? && response.status == 200
+      end
+
+      def job_not_found?(response)
+        response.success? && response.status == 404
+      end
+    end # Job
+  end # LinkedIn
+end # Roseflow

data/lib/roseflow/linkedin/job_list_entry.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+module Roseflow
+  module LinkedIn
+    class JobListEntry < Dry::Struct
+      attribute :company, Types::String
+      attribute :company_url, Types::String
+      attribute :job_title, Types::String
+      attribute :job_url, Types::String
+      attribute :list_date, Types::String
+      attribute :location, Types::String
+
+      def self.from(input)
+        entries = input.dig("job")
+        return [] unless entries
+        entries.map { |entry| new(entry.symbolize_keys) }
+      end
+    end
+  end
+end