opossum 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 072b3d832b3017a8625ed6bd5c16740566eaf4bac7b79347c55834d99b085d90
-  data.tar.gz: 14faf920b01e184b49e434e7ea21e76f2eec76969cf44b6b44d25c37fe83010c
+  metadata.gz: 28f90ba90661894c077eb72004e0300f07e9c2d93059d8221985c396b467b74e
+  data.tar.gz: 29afd0da8dd9f9192caeea525f92365637b75d15816fca846a0a577049ea56d9
 SHA512:
-  metadata.gz: 91125cac82c4d80569be8eb23ec46ebf66daf68b0abc3dfbfb4178ba4730c6889968cc5022578eb14267e58d66c27d50713b948258fea1139fe4065efc28f67e
-  data.tar.gz: 98c0a00e4909966db372da82f7177dc8fdb0d139bbe924f4d5366e5623b7bf98f2540bf76f83d8b5fcd299c6e90942def270d22b991f8e543752d2b1c49fa7e9
+  metadata.gz: cf6f1c1f02604906beb4ea09fb3af644ede569c4ec9dcf962a6f2d851f2ee5fbfedd4a2ade0831b0a677b8ae78e51ced66a919eb12237820658b74014c150d5f
+  data.tar.gz: ccba27fcb4c858e825ca63f494ab97d6246e58078a4369274373170dab71cb11e20dcec00789e924dc52312c696f1073b740a27bd76e99c6e3659dc6e49227c8

data/CHANGELOG.md

@@ -1,7 +1,44 @@
-## [Unreleased]
+## [0.2.0] - 2025-08-06
+
+### Changed
+- **Publisher class initialization** - Improved API design for better usability
+  - Constructor now requires `ig_id` parameter: `Publisher.new(access_token: token, ig_id: account_id)`
+  - `publish_media` method no longer requires `ig_id` parameter (stored in instance)
+  - Simplified method calls: `publisher.publish_media(media_url: url, media_type: 'IMAGE')`
+  - Breaking change: existing code needs to be updated to new initialization pattern
+
+### Added
+- **Authenticator#get_user_info_from_code** - New convenience method that combines authentication flow
+  - Exchanges authorization code for access token
+  - Gets long-lived access token (60-day validity)
+  - Optionally retrieves user information with specified fields
+  - Returns `{ access_token: token_hash }` or `{ access_token: token_hash, user_details: user_info }`
+  - Simplifies common authentication workflow into single method call
 
 ### Improved
-- **Code Quality** - Minor code style improvements for better readability
+- **UserDetails API** - All methods now return hashes with symbol keys instead of string keys
+  - `get_user_info` returns `{ id: "...", username: "...", media_count: 42 }` (Ruby convention)
+  - `get_long_lived_access_token` returns `{ access_token: "...", token_type: "bearer", expires_in: 5184000 }`
+  - `refresh_access_token` returns `{ access_token: "...", token_type: "bearer", expires_in: 5184000 }`
+- **Publisher class refactoring** - Improved code structure and maintainability
+  - Split large methods into smaller, focused functions for better readability
+  - Extracted media container body building logic into separate method
+  - Separated carousel media preparation logic for better organization
+  - Improved status handling with dedicated error management methods
+  - All methods now comply with linting standards (≤10 lines, ≤5 parameters)
+  - Enhanced code modularity while maintaining backward compatibility
+
+### Tests
+- **Complete test suite** - Added comprehensive RSpec test coverage for all components
+  - **Authenticator tests** - Full coverage including new `get_user_info_from_code` method
+    - Tests for both scenarios: with and without fields parameter
+    - Tests for empty fields array handling
+    - Error handling tests for all possible failure points
+    - Mock-based testing with proper isolation
+  - **UserDetails tests** - Updated to work with symbol keys
+  - **Publisher tests** - Complete media publishing workflow coverage
+  - **ApiHelper tests** - HTTP request handling and error scenarios
+  - All 83 tests passing with comprehensive coverage
 
 ## [0.1.0] - 2025-07-31
 

data/README.md

@@ -16,7 +16,7 @@ Before using this gem, you need to:
 Add this line to your application's Gemfile:
 
 ```ruby
-gem 'instagram_publish_api_via_instagram_login'
+gem 'opossum'
 ```
 
 And then execute:
@@ -28,7 +28,7 @@ bundle install
 Or install it yourself as:
 
 ```bash
-gem install instagram_publish_api_via_instagram_login
+gem install oposum
 ```
 
 ## Usage
@@ -38,7 +38,7 @@ This gem provides three independent classes for working with Instagram API:
 ### Authentication
 
 ```ruby
-require 'instagram_publish_api_via_instagram_login'
+require 'opossum'
 
 # Create authenticator
 authenticator = Opossum::Authenticator.new(
@@ -47,27 +47,42 @@ authenticator = Opossum::Authenticator.new(
   redirect_uri: 'your_redirect_uri'
 )
 
-# Exchange code for token
-response = authenticator.exchange_code_for_token(authorization_code)
-access_token = response['access_token']
+# Get user info and long-lived token from authorization code
+result = authenticator.get_user_info_from_code(
+  authorization_code,
+  fields: 'id,user_id'
+)
+# Returns: 
+# { 
+#   access_token: {
+#     access_token: "ACCESS_TOKEN",
+#     token_type: "TOKEN_TYPE",
+#     expires_in: 5183742
+#   },
+#   user_details: {
+#     id: "IG_ID",
+#     user_id: "IG_USER_ID"
+#   }
+# }
+
+# Or get only long-lived token without user details
+result = authenticator.get_user_info_from_code(authorization_code)
+# Returns:
+# { 
+#   access_token: {
+#     access_token: "ACCESS_TOKEN",
+#     token_type: "TOKEN_TYPE",
+#     expires_in: 5183742
+#   }
+# }
 ```
 
-### User Information
+### User Details (Optional)
 
 ```ruby
-# Create user details instance
+# If you need to refresh an existing access token
 user_details = Opossum::UserDetails.new(
-  access_token: access_token
-)
-
-# Get user info
-user_info = user_details.get_user_info(
-  fields: 'id,username,account_type'
-)
-
-# Get long-lived access token (60 days)
-long_lived_token = user_details.get_long_lived_access_token(
-  client_secret: 'your_app_secret'
+  access_token: existing_access_token
 )
 
 # Refresh access token (extends for another 60 days)
@@ -77,21 +92,20 @@ refreshed_token = user_details.refresh_access_token
 ### Publishing
 
 ```ruby
-# Create publisher with access token
+# Create publisher with access token and Instagram business account ID
 publisher = Opossum::Publisher.new(
-  access_token: access_token
+  access_token: access_token,
+  ig_id: instagram_business_account_id
 )
 
 # Publish single image
 result = publisher.publish_media(
-  ig_id: instagram_business_account_id,
   media_url: 'https://example.com/image.jpg',
   media_type: 'IMAGE'
 )
 
 # Publish image with caption
 result = publisher.publish_media(
-  ig_id: instagram_business_account_id,
   media_url: 'https://example.com/image.jpg',
   media_type: 'IMAGE',
   caption: 'Beautiful sunset! 🌅 #nature #photography'
@@ -99,7 +113,6 @@ result = publisher.publish_media(
 
 # Publish carousel with caption
 result = publisher.publish_media(
-  ig_id: instagram_business_account_id,
   media_url: [
     'https://example.com/image1.jpg',
     'https://example.com/image2.jpg'
@@ -122,9 +135,12 @@ The gem includes comprehensive error handling for API responses:
 
 ```ruby
 begin
-  result = client.publish_media(
-    ig_id: instagram_business_account_id,
+  publisher = Opossum::Publisher.new(
     access_token: access_token,
+    ig_id: instagram_business_account_id
+  )
+  
+  result = publisher.publish_media(
     media_url: 'https://example.com/image.jpg'
   )
 rescue Opossum::Error => e
@@ -154,7 +170,7 @@ To install this gem onto your local machine, run `bundle exec rake install`. To
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/ninjarender/instagram_publish_api_via_instagram_login. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/[USERNAME]/instagram_publish_api_via_instagram_login/blob/main/CODE_OF_CONDUCT.md).
+Bug reports and pull requests are welcome on GitHub at https://github.com/ninjarender/opossum. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/[USERNAME]/opossum/blob/main/CODE_OF_CONDUCT.md).
 
 ## License
 
@@ -162,4 +178,4 @@ The gem is available as open source under the terms of the [MIT License](https:/
 
 ## Code of Conduct
 
-Everyone interacting in the OpossumInstagramPublisher project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/ninjarender/instagram_publish_api_via_instagram_login/blob/main/CODE_OF_CONDUCT.md).
+Everyone interacting in the OpossumInstagramPublisher project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/ninjarender/opossum/blob/main/CODE_OF_CONDUCT.md).

data/lib/opossum/authenticator.rb

@@ -1,6 +1,7 @@
 # frozen_string_literal: true
 
 require_relative "api_helper"
+require_relative "user_details"
 
 module Opossum
   # Handles Instagram authentication flow
@@ -23,16 +24,32 @@ module Opossum
       )
     end
 
+    def get_user_info_from_code(code, fields: "")
+      access_token = exchange_code_for_token(code)
+
+      user_details_client = UserDetails.new(access_token: access_token["access_token"])
+      long_lived_access_token = user_details_client.get_long_lived_access_token(client_secret: client_secret)
+
+      return { access_token: long_lived_access_token } if !fields.is_a?(String) || fields.empty?
+
+      user_details = user_details_client.get_user_info(fields: fields)
+
+      {
+        access_token: long_lived_access_token,
+        user_details: user_details
+      }
+    end
+
     private
 
     attr_reader :client_id, :client_secret, :redirect_uri
 
     def token_request_params(code)
       {
-        client_id: @client_id,
-        client_secret: @client_secret,
+        client_id: client_id,
+        client_secret: client_secret,
         grant_type: "authorization_code",
-        redirect_uri: @redirect_uri,
+        redirect_uri: redirect_uri,
         code: code
       }
     end

data/lib/opossum/publisher.rb

@@ -6,10 +6,15 @@ require_relative "base_client"
 module Opossum
   # Handles Instagram media publishing
   class Publisher < BaseClient
-    def publish_media(ig_id:, media_url:, media_type: "IMAGE", caption: nil)
+    def initialize(access_token:, ig_id:)
+      super(access_token: access_token)
+
+      @ig_id = ig_id
+    end
+
+    def publish_media(media_url:, media_type: "IMAGE", caption: nil)
       path = "#{INSTAGRAM_GRAPH_API_ENDPOINT}/#{GRAPH_API_VERSION}/#{ig_id}/media_publish"
-      media_container_id = prepare_media_container(ig_id: ig_id, media_url: media_url,
-                                                   media_type: media_type, caption: caption)
+      media_container_id = prepare_media_container(media_url: media_url, media_type: media_type, caption: caption)
 
       ApiHelper.post(
         path: path,
@@ -19,30 +24,45 @@ module Opossum
 
     private
 
-    def prepare_media_container(ig_id:, media_url:, media_type:, caption:)
+    attr_reader :ig_id
+
+    def prepare_media_container(media_url:, media_type:, caption:)
       if media_url.is_a?(Array)
-        children_ids = media_url.map do |url|
-          create_media_container(
-            ig_id: ig_id, media_url: url, is_carousel_item: true, caption: caption
-          )
-        end
-
-        create_media_container(
-          ig_id: ig_id, media_url: children_ids, media_type: media_type, caption: caption
-        )
+        prepare_carousel_media(media_urls: media_url, media_type: media_type, caption: caption)
       else
-        create_media_container(
-          ig_id: ig_id, media_url: media_url, media_type: media_type, caption: caption
-        )
+        create_media_container(media_url: media_url, media_type: media_type, caption: caption)
       end
     end
 
-    def create_media_container(ig_id:, media_url:, media_type: "IMAGE", is_carousel_item: false, upload_type: nil,
-                               caption: nil)
+    def prepare_carousel_media(media_urls:, media_type:, caption:)
+      children_ids = media_urls.map do |url|
+        create_media_container(media_url: url, is_carousel_item: true, caption: caption)
+      end
+
+      create_media_container(media_url: children_ids, media_type: media_type, caption: caption)
+    end
+
+    def create_media_container(media_url:, media_type: "IMAGE", is_carousel_item: false, upload_type: nil, caption: nil)
       path = "#{INSTAGRAM_GRAPH_API_ENDPOINT}/#{GRAPH_API_VERSION}/#{ig_id}/media"
+      body = build_media_container_body(media_url: media_url, media_type: media_type, caption: caption,
+                                        is_carousel_item: is_carousel_item, upload_type: upload_type)
 
+      response = ApiHelper.post(path: path, body: body)
+      media_container_id = response["id"]
+
+      wait_for_media_container_status(media_container_id: media_container_id)
+      media_container_id
+    end
+
+    def build_media_container_body(media_url:, media_type:, caption:, is_carousel_item:, upload_type:)
       body = { access_token: access_token, media_type: media_type, caption: caption }
+      set_media_url_field(body, media_url, media_type)
+      body[:is_carousel_item] = is_carousel_item if is_carousel_item
+      body[:upload_type] = upload_type if upload_type
+      body
+    end
 
+    def set_media_url_field(body, media_url, media_type)
       case media_type
       when "IMAGE"
         body[:image_url] = media_url
@@ -51,39 +71,35 @@ module Opossum
       when "CAROUSEL"
         body[:children] = media_url
       end
-
-      body[:is_carousel_item] = is_carousel_item if is_carousel_item
-      body[:upload_type] = upload_type if upload_type
-
-      response = ApiHelper.post(path: path, body: body)
-      media_container_id = response["id"]
-
-      wait_for_media_container_status(media_container_id: media_container_id)
-
-      media_container_id
     end
 
     def wait_for_media_container_status(media_container_id:)
       loop do
         status = check_media_container_status(media_container_id: media_container_id)["status"]
+        break if handle_media_container_status(status)
+      end
+    end
 
-        case status
-        when "FINISHED"
-          break
-        when "IN_PROGRESS"
-          sleep 30
-        when "EXPIRED"
-          raise "Media container has expired. The container was not published within 24 hours."
-        when "ERROR"
-          raise "Media container failed to complete the publishing process."
-        when "PUBLISHED"
-          raise "Media container has already been published."
-        else
-          raise "Unknown media container status: #{status}"
-        end
+    def handle_media_container_status(status)
+      case status
+      when "FINISHED" then true
+      when "IN_PROGRESS"
+        sleep 30
+        false
+      when "EXPIRED", "ERROR", "PUBLISHED" then raise_status_error(status)
+      else raise "Unknown media container status: #{status}"
       end
     end
 
+    def raise_status_error(status)
+      messages = {
+        "EXPIRED" => "Media container has expired. The container was not published within 24 hours.",
+        "ERROR" => "Media container failed to complete the publishing process.",
+        "PUBLISHED" => "Media container has already been published."
+      }
+      raise messages[status]
+    end
+
     def check_media_container_status(media_container_id:)
       path = "#{INSTAGRAM_GRAPH_API_ENDPOINT}/#{GRAPH_API_VERSION}/#{media_container_id}?fields=status_code"
 

data/lib/opossum/user_details.rb

@@ -12,7 +12,7 @@ module Opossum
       ApiHelper.get(
         path: path,
         params: { access_token: access_token, fields: fields }
-      )
+      ).transform_keys(&:to_sym)
     end
 
     def get_long_lived_access_token(client_secret:)
@@ -21,7 +21,7 @@ module Opossum
       ApiHelper.get(
         path: path,
         params: { access_token: access_token, client_secret: client_secret, grant_type: "ig_exchange_token" }
-      )
+      ).transform_keys(&:to_sym)
     end
 
     def refresh_access_token
@@ -30,7 +30,7 @@ module Opossum
       ApiHelper.get(
         path: path,
         params: { access_token: access_token, grant_type: "ig_refresh_token" }
-      )
+      ).transform_keys(&:to_sym)
     end
   end
 end

data/lib/opossum/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Opossum
-  VERSION = "0.1.0"
+  VERSION = "0.2.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: opossum
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Vadym Kruchyna
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2025-08-01 00:00:00.000000000 Z
+date: 2025-08-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday