Update LinkedIn::Api::ShareAndSocialStream#add_share for Api v2 #274

dsandstrom · 2019-02-23T02:05:02Z

The path changed to /v2/ugcPosts
More attributes are required in the payload

Along with sending over the comment, you must send the user's "urn"

Example (updated):

client = LinkedIn::Client.new
client.authorize_from_access(token)
client.v2_add_share(urn, { comment: 'hi' })

https://docs.microsoft.com/en-us/linkedin/consumer/integrations/self-serve/share-on-linkedin?context=linkedin/consumer/context

* The path changed to /v2/ugcPosts * More attributes are required in the payload Along with sending over the comment, you must send the user's "urn" Example: ``` client = LinkedIn::Client.new client.authorize_from_access(@delivery_method_attributes[:token]) client.add_share({ comment: 'hi', urn: 'urn' }) ``` https://docs.microsoft.com/en-us/linkedin/consumer/integrations/self-serve/share-on-linkedin?context=linkedin/consumer/context

hexgnu · 2019-02-23T17:21:14Z

@dsandstrom if you want to write a test for this I can review this and merge it and also cut a new gem.

Thanks!

dsandstrom · 2019-02-26T20:08:38Z

Well the problem is this change breaks all other endpoints as they have not been updated for LinkedIn's API v2. I just wanted to show other people what I got working.

hexgnu · 2019-02-27T00:37:41Z

We could do something like Linkedin::V2.add_share too. That way it wouldn't break for others

Can't post without it so no reason to make it an option. Also improve docs

Add the url to the payload. The link title and description are also customizable Example: ``` payload = { comment: "Comment", title: "Link Title", description: "Link Description", url: "http://example.com/article" } client.add_share(urn, payload) ```

Rollback share_and_social_stream file back to master Not sure how you want to keep v2 methods separate, but this allows v1 endpoints to still work. You said to do "something like Linkedin::V2.add_share", but that doesn't really make sense since we run the methods on the LinkedIn::Client. A possibility is to add a LinkedIn::V2::Client, then include the v2 methods into that class.

v2_profile and v2_add_share

dsandstrom · 2019-03-13T00:49:38Z

Not sure how you want to keep v2 methods separate, but this allows v1 endpoints to still work. You said to do "something like Linkedin::V2.add_share", but that doesn't really make sense since we run
the methods on the LinkedIn::Client. A possibility is to add a LinkedIn::V2::Client, then include the v2 methods into that class.

A comment is always required

hexgnu · 2019-04-08T15:37:20Z

lib/linked_in/api/v2.rb

+      # @see https://docs.microsoft.com/en-us/linkedin/consumer/integrations/self-serve/sign-in-with-linkedin?context=linkedin/consumer/context#retrieving-member-profiles
+      #
+      # @return [void]
+      def v2_profile


nitpick: def profile since it's already scoped to V2

hexgnu · 2019-04-08T15:38:05Z

lib/linked_in/api/v2.rb

+      #
+      # @macro share_input_fields
+      # @return [void]
+      def v2_add_share(urn, share = {})


Again with the same nitpick. I feel like if it is already scoped to a V2 module it should just be without a prefix on the method.

hexgnu · 2019-04-08T15:42:59Z

lib/linked_in/api/v2.rb

+            }
+          }
+
+          return add_url_to_payload(payload, share) if share[:url]


this is a nitpick of mine.

I would prefer it to look something more like

if share.has_key?(:url) add_url_to_payload(payload, share) else add_comment_to_payload(payload,share) end

also I think

if !!share.fetch(:url, false) ... end

hexgnu · 2019-04-08T15:47:58Z

lib/linked_in/api/v2.rb

+      # @macro share_input_fields
+      # @return [void]
+      def v2_add_share(urn, share = {})
+        if !urn.instance_of?(String) || urn.empty?


I think that really what you're after is something like this:

(urn.respond_to?(:empty?) && urn.empty?) || !urn

hexgnu · 2019-04-08T15:49:54Z

lib/linked_in/api/v2.rb

+      def v2_add_share(urn, share = {})
+        if !urn.instance_of?(String) || urn.empty?
+          raise LinkedIn::Errors::UnavailableError, 'LinkedIn API: URN required'
+        elsif share[:comment].nil?


I think this will be safer

!share.fetch(:comment, false)

hexgnu · 2019-04-08T15:51:43Z

lib/linked_in/api/v2.rb

+
+        def add_url_to_payload(payload, share)
+          media = { status: 'READY', originalUrl: share[:url] }
+          if share[:description]


these are tough because we are checking if they are in the hash, but should we be checking for things like blankness?

hexgnu · 2019-04-08T15:52:30Z

lib/linked_in/client.rb

    include Api::QueryHelpers
    include Api::People
    include Api::Groups
    include Api::Companies
    include Api::Jobs
    include Api::ShareAndSocialStream
    include Api::Communications
+    include Api::V2


oh I see why you prefixed the methods now...

hmmm... well I suppose that's ok it just feels a bit awkward to me is all.

hexgnu · 2019-04-08T15:54:14Z

nice work! I just put a few comments, mostly nitpicks and question type things.

I'm wondering if we should do something besides the prefixing of the methods for v2_* requests.

I think it's ok, it just feels a bit weird is all since v1 is mostly deprecated at this point.

dsandstrom · 2019-04-08T16:43:59Z

Prefixing with v2 was just temporary. A V2 module needs to be set up. See #274 (comment)

hexgnu · 2019-04-08T16:48:51Z

Yea Linkedin::V2::Client makes sense. if you want to do that.

addbrick · 2019-04-18T22:58:01Z

@hexgnu @dsandstrom Just a heads up I added the email endpoint in a fork and opened a PR on @dsandstrom fork. dsandstrom#1. My company needs it for our auth flow.

addbrick · 2019-04-19T01:35:51Z

@hexgnu @dsandstrom I ended up adding a little more to my pr it now includes the additions:

Default fields to the /me endpoint, which are now required by LinkedIn
Support for the v2 email address endpoint
Parsing of the raw JSON responses from me and email endpoints
Specs covering what was added above

dsandstrom#1

Meant to say this the first time, but I did not address any of the outstanding pr comments.

hexgnu · 2019-04-22T20:49:58Z

If you all want to combine forces feel free to do so :) will gladly review and merge in.

malissa · 2020-04-24T14:23:46Z

@dsandstrom @addbrick - great work! Thank you for doing this! If you all can get this in I can't wait to use it :)

hexgnu · 2020-04-24T21:07:03Z

Again happy to help merge this stuff in I just don't work with the linkedin API anymore so I'd be flying blind here 😄.

dsandstrom mentioned this pull request Feb 23, 2019

LinkedIn v1 API deprecation #272

Open

Darrell Sandstrom added 5 commits February 28, 2019 17:03

Make urn required by #add_share

2a7e4bf

Can't post without it so no reason to make it an option. Also improve docs

Add support for sharing urls to v2

6a0c254

Add the url to the payload. The link title and description are also customizable Example: ``` payload = { comment: "Comment", title: "Link Title", description: "Link Description", url: "http://example.com/article" } client.add_share(urn, payload) ```

Add specs for LinkedIn::Api::V2

b7fdad9

v2_profile and v2_add_share

Fix spec titles

68eee85

Darrell Sandstrom added 3 commits March 12, 2019 18:15

Refactor LinkedInApi::V2

299840f

Change requirements for LinkedIn::Api::V2#v2_add_share

f45a6d4

A comment is always required

Fix spacing

ea4b000

hexgnu reviewed Apr 8, 2019

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Update LinkedIn::Api::ShareAndSocialStream#add_share for Api v2 #274

Update LinkedIn::Api::ShareAndSocialStream#add_share for Api v2 #274

dsandstrom commented Feb 23, 2019 •

edited

Loading

hexgnu commented Feb 23, 2019

dsandstrom commented Feb 26, 2019

hexgnu commented Feb 27, 2019

dsandstrom commented Mar 13, 2019

hexgnu Apr 8, 2019

hexgnu Apr 8, 2019

hexgnu Apr 8, 2019

hexgnu Apr 8, 2019

hexgnu Apr 8, 2019

hexgnu Apr 8, 2019

hexgnu Apr 8, 2019

hexgnu Apr 8, 2019

hexgnu commented Apr 8, 2019

dsandstrom commented Apr 8, 2019

hexgnu commented Apr 8, 2019

addbrick commented Apr 18, 2019

addbrick commented Apr 19, 2019 •

edited

Loading

hexgnu commented Apr 22, 2019

malissa commented Apr 24, 2020

hexgnu commented Apr 24, 2020

Update LinkedIn::Api::ShareAndSocialStream#add_share for Api v2 #274

Are you sure you want to change the base?

Update LinkedIn::Api::ShareAndSocialStream#add_share for Api v2 #274

Conversation

dsandstrom commented Feb 23, 2019 • edited Loading

hexgnu commented Feb 23, 2019

dsandstrom commented Feb 26, 2019

hexgnu commented Feb 27, 2019

dsandstrom commented Mar 13, 2019

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

hexgnu commented Apr 8, 2019

dsandstrom commented Apr 8, 2019

hexgnu commented Apr 8, 2019

addbrick commented Apr 18, 2019

addbrick commented Apr 19, 2019 • edited Loading

hexgnu commented Apr 22, 2019

malissa commented Apr 24, 2020

hexgnu commented Apr 24, 2020

dsandstrom commented Feb 23, 2019 •

edited

Loading

addbrick commented Apr 19, 2019 •

edited

Loading