linketysplit 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: ee44a0b1f2a131b41e472206c3bd2cea44a63012f064de1952e0f91a01ea90c4
+  data.tar.gz: ebab559af5f7228e270bd6d203e94cc3eca48b874287aa9e551d5e61d909808b
+SHA512:
+  metadata.gz: 9d8692ef4d2f8da658c7c4bb7874265ef403a4d158d9844877b446cf03b422fced79b3d53823867112dbec72407041593c00f50eb0d0d1ace5d4440bdd8e9d32
+  data.tar.gz: 4a3ddadf7e066661d77a9d995487cc305443417cccb62f34eacae3b10c7b566ed6611377afdcd2d2a6a79e8b3683827d0edf610c48406fa224c44b667c1c3b79

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2024 Christopher Carson
+
+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,42 @@
+# linketysplit
+
+[![Gem Version](https://img.shields.io/gem/v/linketysplit)](https://rubygems.org/gems/linketysplit)
+[![Gem Downloads](https://img.shields.io/gem/dt/linketysplit)](https://www.ruby-toolbox.com/projects/linketysplit)
+[![GitHub Workflow Status](https://img.shields.io/github/actions/workflow/status/LinketySplit/linketysplit-ruby/ci.yml)](https://github.com/LinketySplit/linketysplit-ruby/actions/workflows/ci.yml)
+[![Code Climate maintainability](https://img.shields.io/codeclimate/maintainability/LinketySplit/linketysplit-ruby)](https://codeclimate.com/github/LinketySplit/linketysplit-ruby)
+
+TODO: Description of this gem goes here.
+
+---
+
+- [Quick start](#quick-start)
+- [Support](#support)
+- [License](#license)
+- [Code of conduct](#code-of-conduct)
+- [Contribution guide](#contribution-guide)
+
+## Quick start
+
+```
+gem install linketysplit
+```
+
+```ruby
+require "linketysplit"
+```
+
+## Support
+
+If you want to report a bug, or have ideas, feedback or questions about the gem, [let me know via GitHub issues](https://github.com/LinketySplit/linketysplit-ruby/issues/new) and I will do my best to provide a helpful answer. Happy hacking!
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](LICENSE.txt).
+
+## Code of conduct
+
+Everyone interacting in this project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](CODE_OF_CONDUCT.md).
+
+## Contribution guide
+
+Pull requests are welcome!

data/lib/linketysplit/api_endpoints.rb

@@ -0,0 +1,84 @@
+require "typhoeus"
+require "json"
+require "cgi"
+
+module Linketysplit
+  class ApiEndpointFailedError < StandardError; end
+
+  class ApiError < StandardError
+    attr_reader :status_code
+
+    def initialize(response)
+      @status_code = response.code
+      data = JSON.parse(response.body)
+      message = data["message"].is_a?(String) ? data["message"] : "An unknown error occurred"
+      super(message)
+    end
+  end
+
+  class ApiEndpoints
+    attr_reader :linketysplit_origin,
+                :api_key
+
+    def initialize(api_key, linketysplit_origin="https://linketysplit.com")
+      @api_key = api_key
+      @linketysplit_origin = linketysplit_origin
+    end
+
+    def handle_response(response)
+      if response.success?
+        { error: nil, data: JSON.parse(response.body) }
+      elsif response.timed_out?
+        { error: ApiEndpointFailedError.new("API request to #{url} timed out"), data: nil }
+      elsif response.code == 0
+        { error: ApiEndpointFailedError.new("API request to #{url} failed"), data: nil }
+      else
+        { error: ApiError.new(response), data: nil }
+      end
+    end
+
+    def get(url)
+      response = Typhoeus.get(
+        url,
+        headers: { "Authorization" => "Bearer #{api_key}", "Accept" => "application/json" }
+      )
+      handle_response(response)
+    end
+
+    def post(url, data)
+      response = Typhoeus.post(
+        url,
+        headers: {
+          "Authorization" => "Bearer #{api_key}",
+          "Content-Type"  => "application/json",
+          "Accept"        => "application/json"
+        },
+        body: JSON.dump(data)
+      )
+      handle_response(response)
+    end
+
+    def publication
+      url = "#{linketysplit_origin}/api/v1/publication"
+      get(url)
+    end
+
+    def article(permalink)
+      encoded_permalink = CGI.escape(permalink)
+      url = "#{linketysplit_origin}/api/v1/publication/article/#{encoded_permalink}"
+      get(url)
+    end
+
+    def upsert_article(permalink)
+      url = "#{linketysplit_origin}/api/v1/publication/article"
+      data = { permalink: }
+      post(url, data)
+    end
+
+    def verify_article_access(article_access_id)
+      url = "#{linketysplit_origin}/api/v1/publication/verify-article-access"
+      data = { articleAccessId: article_access_id }
+      post(url, data)
+    end
+  end
+end

data/lib/linketysplit/publication_sdk.rb

@@ -0,0 +1,46 @@
+require "jwt"
+require "base64"
+require "json"
+
+module Linketysplit
+  class PublicationSdk
+    attr_reader :api_key
+
+    def initialize(api_key)
+      @api_key = api_key
+    end
+
+    # Creates a signed article purchase link with the given permalink.
+    #
+    # @param permalink [String] The canonical URL of the article.
+    # @param customPricing [Hash, nil] Optional. Custom pricing to be applied for this purchase link,
+    #   that is, for a particular user.
+    #   - `:price` [Integer] The base article price in US cents.
+    #   - `:discounts` [Array<Hash>] Optional. Quantity discounts.
+    #     - `:quantity` [Integer] The minimum quantity at which the discount applies.
+    #     - `:price` [Integer] The unit price of the article at the given quantity.
+    # @param context [String, nil] Optional. Pass "sharing" if the user is sharing an article.
+    # @return [String] The URL of the purchase page on LinketySplit. Show the reader a link to this URL.
+    def create_article_purchase_link(permalink, custom_pricing=nil, context=nil)
+      payload = {
+        permalink:
+      }
+
+      payload[:customPricing] = custom_pricing if custom_pricing
+
+      payload[:context] = context if context
+      token = JWT.encode payload, @api_key, "HS256"
+      "https://linketysplit.com/purchase-link/#{token}"
+    end
+
+    def self.get_linketysplit_pricing_meta_tag(article_pricing)
+      content = Base64.encode64(JSON.dump(article_pricing))
+      "<meta property=\"linketysplit:pricing\" content=\"#{content}\" />"
+    end
+
+    def self.get_linketysplit_enabled_meta_tag(enabled: true)
+      content = enabled ? "true" : "false"
+      "<meta property=\"linketysplit:enabled\" content=\"#{content}\" />"
+    end
+  end
+end

data/lib/linketysplit/version.rb

@@ -0,0 +1,3 @@
+module Linketysplit
+  VERSION = "0.1.0".freeze
+end

data/lib/linketysplit.rb

@@ -0,0 +1,6 @@
+module Linketysplit
+  autoload :VERSION, "linketysplit/version"
+  autoload :PublicationSdk, "linketysplit/publication_sdk"
+  autoload :ApiError, "linketysplit/api_error"
+  autoload :ApiEndpoints, "linketysplit/api_endpoints"
+end

metadata

@@ -0,0 +1,96 @@
+--- !ruby/object:Gem::Specification
+name: linketysplit
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Christopher Carson
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2024-06-27 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: jwt
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.8.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.8.2
+- !ruby/object:Gem::Dependency
+  name: oga
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.4'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.4'
+- !ruby/object:Gem::Dependency
+  name: typhoeus
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.4'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.4'
+description:
+email:
+- chris@nowzoo.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE.txt
+- README.md
+- lib/linketysplit.rb
+- lib/linketysplit/api_endpoints.rb
+- lib/linketysplit/publication_sdk.rb
+- lib/linketysplit/version.rb
+homepage: https://github.com/LinketySplit/linketysplit-ruby
+licenses:
+- MIT
+metadata:
+  bug_tracker_uri: https://github.com/LinketySplit/linketysplit-ruby/issues
+  changelog_uri: https://github.com/LinketySplit/linketysplit-ruby/releases
+  source_code_uri: https://github.com/LinketySplit/linketysplit-ruby
+  homepage_uri: https://github.com/LinketySplit/linketysplit-ruby
+  rubygems_mfa_required: 'true'
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '3.1'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.5.14
+signing_key:
+specification_version: 4
+summary: SDK for interactiong with LinketySplit
+test_files: []