linkedin-ruby 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 4ea84838fd42d284acc2313a1d05036cda8c08fc86a1e6a87378d73a0884bc67
+  data.tar.gz: e264a8647ac465472c35c132cc9d449ea7c1cf8fa26aba4e6eef01b1ac893a8f
+SHA512:
+  metadata.gz: 75786e0fc5a60ca0759ac1f51ce635fcf55ca39d52693789f2de733ec5311b9e8a40f78bc587983fe686d318cab3dc58d07dada7d96e0a73b3650dde450964e7
+  data.tar.gz: 2b2fa114d47313d85605cb2874b33568727412460504ce1662f8eb307c931dff0fd2972570fa32da7d07e2a5560dba46bb7317929cdf53015feb040fd5a6407f

data/.gitignore

@@ -0,0 +1,11 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status

data/.rspec

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

data/.travis.yml

@@ -0,0 +1,7 @@
+---
+sudo: false
+language: ruby
+cache: bundler
+rvm:
+  - 2.3.0
+before_install: gem install bundler -v 1.16.6

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers 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, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at prakash@mallow-tech.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,6 @@
+source "https://rubygems.org"
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in linkedin-ruby.gemspec
+gemspec

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2019 MallowTech Developers
+
+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,148 @@
+# Linkedin
+
+Ruby-wrapper for LinkedIn API version 2 with Oauth2 support.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'linkedin-ruby'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install linkedin-ruby
+
+## Usage
+
+**[Step 1:](#step-1-register-your-application)** [Register](https://www.linkedin.com/secure/developer) your
+ application with LinkedIn. They will give you a **Client ID** (aka API
+ Key) and a **Client Secret** (aka Secret Key)
+ 
+ **[Step 2:](#step-2-getting-an-access-token)** Use your **Client ID** and **Client Secret** to obtain an **Access Token** from some user.
+ 
+ **[Step 3:](#step-3-using-linkedins-api)** Use an **Access Token** to query the API.
+ 
+ ```ruby
+ api = LinkedIn::API.new(access_token)
+ me = api.profile
+ ```
+ 
+ ## Step 1: Register your Application
+ 
+ You first need to create and register an application with LinkedIn
+ [here](https://www.linkedin.com/secure/developer).
+ 
+ You will not be able to use any part of the API without registering first.
+ 
+ Once you have registered you will need to take note of a few key items on
+ your Application Details page.
+ 
+ 1. **API Key** - We refer to this as your client id or `client_id`
+ 1. **Secret Key** - We refer to this as your client secret or
+    `client_secret`
+ 1. **Default Scope** - This is the set of permissions you request from
+    users when they connect to your app. If you want to set this on a
+    request-by-request basis, you can use the `scope` option with the
+    `auth_code_url` method.
+ 1. **OAuth 2.0 Redirect URLs** - For security reasons, the url you enter
+    in this box must exactly match the `redirect_uri` you use in this gem.
+ 
+ You do NOT need **OAuth User Token** nor **OAuth User Secret**. That is
+ for OAuth 1.0. This gem is for OAuth 2.0.
+ 
+ ## Step 2: Getting An Access Token
+ 
+ All LinkedIn API requests must be made in the context of an access token.
+ The access token encodes what LinkedIn information your AwesomeApp® can
+ gather on behalf of "John Doe".
+ 
+ There are a few different ways to get an access token from a user.
+ 
+ 1. You can use [LinkedIn's Javascript API](https://developer.linkedin.com/documents/javascript-api-reference-0) to authenticate on the front-end and then pass the access token to the backend via [this procedure](https://developer.linkedin.com/documents/exchange-jsapi-tokens-rest-api-oauth-tokens).
+ 
+ 1. If you use OmniAuth, I would recommend looking at [decioferreira/omniauth-linkedin-oauth2](https://github.com/decioferreira/omniauth-linkedin-oauth2) to help automate authentication.
+ 
+ 1. You can do it manually using this linkedin-ruby gem and the steps
+    below.
+ 
+ Here is how to get an access token using this linkedin-ruby gem:
+ 
+ ### Step 2A: Configuration
+ 
+ You will need to configure the following items:
+ 
+ 1. Your **client id** (aka API Key)
+ 1. Your **client secret** (aka Secret Key)
+ 1. Your **redirect uri**. On LinkedIn's website you must input a list of
+    valid redirect URIs. If you use the same one each time, you can set it
+    in the `LinkedIn.configure` block. If your redirect uris change
+    depending on business logic, you can pass it into the `auth_code_url`
+    method.
+ 
+ ```ruby
+ # It's best practice to keep secret credentials out of source code.
+ # You can, of course, hardcode dev keys or directly pass them in as the
+ # first two arguments of LinkedIn::OAuth2.new
+ LinkedIn.configure do |config|
+   config.client_id     = ENV["LINKEDIN_CLIENT_ID"]
+   config.client_secret = ENV["LINKEDIN_CLIENT_SECRET"]
+ 
+   # This must exactly match the redirect URI you set on your application's
+   # settings page. If your redirect_uri is dynamic, pass it into
+   # `auth_code_url` instead.
+   config.redirect_uri  = "https://example.io/linkedin/oauth2"
+ end
+ ```
+ 
+ ### Step 2B: Get Auth Code URL
+ 
+ ```ruby
+ oauth = LinkedIn::OAuth2.new
+ 
+ url = oauth.auth_code_url
+ ```
+ 
+ ### Step 2C: User Sign In
+ 
+ You must now load url from Step 2B in a browser. It will pull up the
+ LinkedIn sign in box. Once LinkedIn user credentials are entered, the box
+ will close and redirect to your redirect url, passing along with it the
+ **OAuth code** as the `code` GET param.
+ 
+ Be sure to read the extended documentation around the LinkedIn::OAuth2
+ module for more options you can set.
+ 
+ **Note:** The **OAuth code** only lasts for ~20 seconds!
+ 
+ ### Step 2D: Get Access Token
+ 
+ ```ruby
+ code = "THE_OAUTH_CODE_LINKEDIN_GAVE_ME"
+ 
+ access_token = oauth.get_access_token(code)
+ ```
+ 
+ Now that you have an access token, you can use it to query the API.
+ 
+ The `LinkedIn::OAuth2` inherits from [intreda/oauth2](https://github.com/intridea/oauth2)'s `OAuth2::Client` class. See that gem's [documentation](https://github.com/intridea/oauth2/blob/master/lib/oauth2/client.rb) for more usage examples.
+
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/linkedin-ruby. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+## Code of Conduct
+
+Everyone interacting in the Linkedin project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/linkedin-ruby/blob/master/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/lib/linked_in/access_token.rb

@@ -0,0 +1,24 @@
+module LinkedIn
+  # A simple data object to contain the token string and expiration data.
+  class AccessToken
+    attr_accessor :token, :expires_in, :expires_at
+
+    # Creates a simple data wrapper for an access token.
+    #
+    # LinkedIn returns only an `expires_in` value. This calculates and
+    # sets and `expires_at` field for convenience.
+    #
+    # @param [String] token the access token
+    # @param [FixNum] expires_in number of seconds the token lasts for
+    # @param [Time] expires_at when the token will expire.
+    def initialize(token=nil, expires_in=nil, expires_at=nil)
+      self.token = token
+      self.expires_in = expires_in
+      if expires_at.nil? and not self.expires_in.nil?
+        self.expires_at = Time.now + expires_in
+      else
+        self.expires_at = expires_at
+      end
+    end
+  end
+end

data/lib/linked_in/api.rb

@@ -0,0 +1,60 @@
+module LinkedIn
+  class API
+
+    attr_accessor :access_token
+
+    def initialize(access_token = nil)
+      access_token = parse_access_token(access_token)
+      verify_access_token!(access_token)
+      @access_token = access_token
+
+      @connection = LinkedIn::Connection.new headers: default_headers do |conn|
+        conn.request :multipart
+        conn.adapter Faraday.default_adapter
+      end
+
+      initialize_endpoints
+    end
+
+    extend Forwardable # Composition over inheritance
+
+    def_delegators :@people, :profile
+
+    def_delegators :@organizations, :organization,
+                   :organization_acls
+
+    def_delegators :@share_and_social_stream, :share
+
+    private ##############################################################
+
+    def initialize_endpoints
+      @people = LinkedIn::People.new(@connection)
+      @organizations = LinkedIn::Organizations.new(@connection)
+      @share_and_social_stream = LinkedIn::ShareAndSocialStream.new(@connection)
+    end
+
+    def default_headers
+      # https://developer.linkedin.com/documents/api-requests-json
+      return {"x-li-format" => "json", "Authorization" => "Bearer #{@access_token.token}"}
+    end
+
+    def verify_access_token!(access_token)
+      unless access_token.is_a? LinkedIn::AccessToken
+        raise no_access_token_error
+      end
+    end
+
+    def parse_access_token(access_token)
+      if access_token.is_a? LinkedIn::AccessToken
+        return access_token
+      elsif access_token.is_a? String
+        return LinkedIn::AccessToken.new(access_token)
+      end
+    end
+
+    def no_access_token_error
+      msg = LinkedIn::ErrorMessages.no_access_token
+      LinkedIn::InvalidRequest.new(msg)
+    end
+  end
+end

data/lib/linked_in/api_resource.rb

@@ -0,0 +1,180 @@
+module LinkedIn
+  # The abstract class all API endpoints inherit from. Providers common
+  # builder methods across all endpoints.
+  #
+  # @!macro profile_options
+  #   @options opts [String] :id LinkedIn ID to fetch profile for
+  #   @options opts [String] :url The profile url
+  #   @options opts [String] :lang Requests the language of the profile.
+  #     Options are: en, fr, de, it, pt, es
+  #   @options opts [Array, Hash] :fields fields to fetch. The list of
+  #     fields can be found at
+  #     https://developer.linkedin.com/documents/profile-fields
+  #   @options opts [String] :secure (true) specify if urls in the
+  #     response should be https
+  #   @options opts [String] :"secure-urls" (true) alias to secure option
+  #
+  # @!macro share_input_fields
+  #   @param [Hash] share content of the share
+  #   @option share [String] :comment
+  #   @option share [String] :content
+  #   @option share [String] :title
+  #   @option share [String] :submitted-url
+  #   @option share [String] :submitted-image-url
+  #   @option share [String] :description
+  #   @option share [String] :visibility
+  #   @option share [String] :code
+  #
+  # @!macro organization_path_options
+  #   @param [Hash] options identifies the organization profile you want
+  #   @option options [String] :email_domain organization email domain
+  #   @option options [String] :id organization ID
+  #   @option options [String] :urn organization URN
+  #   @option options [String] :vanity_name organization vanity name
+  #
+  # @!macro brand_path_options
+  #   @param [Hash] options identifies the brand profile you want
+  #   @option options [String] :id brand ID
+  #   @option options [String] :vanity_name brand vanity name
+  #   @option options [String] :parent_id brand's parent organization ID.
+  class APIResource
+
+    def initialize(connection)
+      @connection = connection
+    end
+
+    def urn_to_id(urn)
+      urn.split(':').last
+    end
+
+    def id_to_urn(resource, id)
+      ['urn', 'li', resource, id].join(':')
+    end
+
+    protected ############################################################
+
+    def get(path, options={})
+      url, params, headers = prepare_connection_params(path, options)
+
+      response = @connection.get(url, params, headers)
+      Mash.from_json(response.body)
+    end
+
+    def post(path=nil, body=nil, headers=nil, &block)
+      @connection.post(prepend_prefix(path), body, headers, &block)
+    end
+
+    def put(path=nil, body=nil, headers=nil, &block)
+      @connection.put(prepend_prefix(path), body, headers, &block)
+      Mash.from_json(response.body)
+    end
+
+    def delete(path=nil, body=nil, headers=nil, &block)
+      # @connection.delete(prepend_prefix(path), params, headers, &block)
+      # To be able to DELETE with a body:
+      response = @connection.run_request(:delete, prepend_prefix(path), body, headers, &block)
+
+      Mash.from_json(response.body)
+    end
+
+    def deprecated
+      LinkedIn::Deprecated.new(LinkedIn::ErrorMessages.deprecated)
+    end
+
+    private ##############################################################
+
+    def prepend_prefix(path)
+      return @connection.path_prefix + path
+    end
+
+    def prepare_connection_params(path, options)
+      path = prepend_prefix(path)
+      path += generate_field_selectors(options)
+
+      headers = options.delete(:headers) || {}
+
+      params = format_options_for_query(options)
+
+      return [path, params, headers]
+    end
+
+    # Dasherizes the param keys
+    def format_options_for_query(options)
+      options.reduce({}) do |list, kv|
+        key, value = kv.first.to_s.gsub("_","-"), kv.last
+        list[key]  = value
+        list
+      end
+    end
+
+    def generate_field_selectors(options)
+      default = LinkedIn.config.default_profile_fields || {}
+      fields = options.delete(:fields) || default
+      if options.delete(:public)
+        return ":public"
+      elsif fields.empty?
+        return ""
+      else
+        return "?projection=(#{fields})"
+      end
+    end
+
+    def build_fields_params(fields)
+      if fields.is_a?(Hash) && !fields.empty?
+        fields.map {|v| "(#{build_fields_params(v)})" }.join(',')
+      elsif fields.respond_to?(:each)
+        fields.map {|field| build_fields_params(field) }.join(',')
+      else
+        fields.to_s.gsub("_", "-")
+      end
+    end
+
+    def profile_path(options={}, allow_multiple=true)
+      path = "/people"
+
+      id = options.delete(:id)
+      url = options.delete(:url)
+
+      ids = options.delete(:ids)
+      urls = options.delete(:urls)
+
+      if options.delete(:email) then raise deprecated end
+
+      if (id or url)
+        path += single_person_path(id, url)
+      elsif allow_multiple and (ids or urls)
+        path += multiple_people_path(ids, urls)
+      else
+        path = "/me"
+      end
+    end
+
+    def single_person_path(id=nil, url=nil)
+      if id
+        return "/id=#{id}"
+      elsif url
+        return "/url=#{CGI.escape(url)}"
+      else
+        return "/me"
+      end
+    end
+
+    # See syntax here: https://developer.linkedin.com/documents/field-selectors
+    def multiple_people_path(ids=[], urls=[])
+      if ids.nil? then ids = [] end
+      if urls.nil? then urls = [] end
+
+      ids = ids.map do |id|
+        if is_self(id) then "me" else "id=#{id}" end
+      end
+      urls = urls.map do |url|
+        if is_self(url) then "me" else "url=#{CGI.escape(url)}" end
+      end
+      return "::(#{(ids+urls).join(",")})"
+    end
+
+    def is_self(str)
+      str == "self" or str == "me"
+    end
+  end
+end