uscreen_api 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 7eb14d38f28ebdd8aedd1deedabf0977b33dbb52cedb22c2921c753152bb17d5
+  data.tar.gz: a4c4c4882e9a4b832d03497dac3e0c52c8b8d1a83d84663c9c85a97246b900ae
+SHA512:
+  metadata.gz: 0ac100e9869c6963735ad891b770019e858c23aeb8bba1b934f8a5c34e730ea203fae024797e0447d6dac30728783aa5b259e96dbaff62e38b255df7db62d987
+  data.tar.gz: 3f2f2cfc17284449ad7af18d90c56d9955cdb701ad70333d0d2c308fd8e774defff0131bc77b3938fc41d1880b9fdd33f8f628e2478c2416809152a4a5edf501

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2024 Andrei Bondarev
+
+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,32 @@
+# UscreenAPI
+
+Client library for the [Uscreen.tv](https://www.uscreen.tv/) APIs.
+
+![Tests status](https://github.com/andreibondarev/uscreen_api/actions/workflows/ci.yml/badge.svg)
+[![Gem Version](https://badge.fury.io/rb/uscreen_api.svg)](https://badge.fury.io/rb/uscreen_api)
+[![Docs](http://img.shields.io/badge/yard-docs-blue.svg)](http://rubydoc.info/gems/uscreen_api)
+[![License](https://img.shields.io/badge/license-MIT-green.svg)](https://github.com/andreibondarev/uscreen_api/blob/main/LICENSE.txt)
+
+## Installation
+
+```bash
+gem install uscreen_api
+```
+
+## Usage
+
+TODO: Write usage instructions here
+
+## 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 the created tag, 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/andreibondarev/uscreen_api.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/lib/uscreen_api/base.rb

@@ -0,0 +1,19 @@
+module UscreenAPI
+  class Base
+    attr_reader :client
+
+    def initialize(client:)
+      @client = client
+    end
+
+    private
+
+    def handle_errors(status, body)
+      case status
+      when 401 then raise UscreenAPI::Errors::Unauthorized.new(body)
+      when 404 then raise UscreenAPI::Errors::UserNotFound.new(body)
+      when 422 then raise UscreenAPI::Errors::UserNotCreated.new(body)
+      end
+    end
+  end
+end

data/lib/uscreen_api/client.rb

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+require "faraday"
+
+module UscreenAPI
+  class Client
+    attr_reader :api_key
+
+    BASE_URL = "https://www.uscreen.io/publisher_api/v1/"
+
+    def initialize(api_key:)
+      @api_key = api_key
+    end
+
+    def customers
+      @customers ||= UscreenAPI::Customers.new(client: self)
+    end
+
+    def connection
+      @connection = Faraday.new(
+        url: BASE_URL,
+        headers: {
+          "Content-Type": "application/json",
+          Authorization: api_key
+        }
+      ) do |f|
+        f.request(:json)
+        f.response(:json)
+      end
+    end
+  end
+end

data/lib/uscreen_api/customers.rb

@@ -0,0 +1,171 @@
+# frozen_string_literal: true
+
+module UscreenAPI
+  class Customers < Base
+    PATH = "customers"
+
+    # Get paginated list of customers
+    # @param page [Integer] Page number
+    # @param from [String] Starting date and time for the filter range, formatted in RFC 3339. Example: 2023-01-01T00:00:00Z
+    # @param to [String] Ending date and time for the filter range, formatted in RFC 3339. Example: 2023-01-01T00:00:00Z
+    # @param date_field [String] Date field to filter by. Available fields: created_at, updated_at. Default: created_at. If not set, created_at is used.
+    def list(
+      page: nil,
+      from: nil,
+      to: nil,
+      date_field: nil
+    )
+      response = client.connection.get(PATH) do |req|
+        req.params = {}
+
+        req.params["page"] = page if page
+        req.params["from"] = from if from
+        req.params["to"] = to if to
+        req.params["date_field"] = date_field if date_field
+      end
+
+      handle_errors(response.status, response.body)
+
+      response.body
+    end
+
+    # Invite a new customer
+    # @param email [String] Customer email
+    # @param name [String] Customer name
+    # @param password [String] Customer password
+    # @param payment_user_id [String] Payment user ID
+    # @param skip_invite [Boolean] Skip invite email
+    # @param opted_in_for_news_and_updates [Boolean] Opted in for news and updates
+    # @param custom_fields [Hash] Custom fields
+    def create(
+      email:,
+      name:,
+      password:,
+      payment_user_id: nil,
+      skip_invite: nil,
+      opted_in_for_news_and_updates: nil,
+      custom_fields: {}
+    )
+      response = client.connection.post(PATH) do |req|
+        req.body = {}
+
+        req.body["email"] = email if email
+        req.body["name"] = name if name
+        req.body["password"] = password if password
+        req.body["payment_user_id"] = payment_user_id if payment_user_id
+        req.body["skip_invite"] = skip_invite if skip_invite
+        req.body["opted_in_for_news_and_updates"] = opted_in_for_news_and_updates if opted_in_for_news_and_updates
+
+        custom_fields.each { |key, value| req.body[key] = value } if custom_fields.any?
+      end
+
+      handle_errors(response.status, response.body)
+
+      response.body
+    end
+
+    # Get a customer information
+    # @param id [Integer] Customer ID or Email
+    def get(id:)
+      response = client.connection.get("#{PATH}/#{id}")
+
+      handle_errors(response.status, response.body)
+
+      response.body
+    end
+
+    # Update a customer information
+    # @param id [Integer] Customer ID or Email
+    # @param email [String] New customer email
+    # @param name [String] New customer name
+    # @param password [String] New customer password
+    # @param custom_fields [Hash] Custom fields
+    def update(
+      id:,
+      email: nil,
+      name: nil,
+      password: nil,
+      custom_fields: {}
+    )
+      response = client.connection.put("#{PATH}/#{id}") do |req|
+        req.body = {}
+
+        req.body["email"] = email if email
+        req.body["name"] = name if name
+        req.body["password"] = password if password
+
+        custom_fields.each { |key, value| req.body[key] = value } if custom_fields.any?
+      end
+
+      handle_errors(response.status, response.body)
+
+      response.body
+    end
+
+    # Generates a Single Sign-On link for a customer
+    # @param id [Integer] Customer ID or Email
+    def tokenized_url(id:)
+      response = client.connection.post("#{PATH}/#{id}/tokenized_url")
+      handle_errors(response.status, response.body)
+
+      response.body
+    end
+
+    # Get paginated list of accesses for a customer
+    # @param id [Integer] Customer ID or Email
+    # @param page [Integer] Page number
+    # @param from [String] Starting date and time for the filter range, formatted in RFC 3339. Example: 2023-01-01T00:00:00Z
+    # @param to [String] Ending date and time for the filter range, formatted in RFC 3339. Example: 2023-01-01T00:00:00Z
+    def accesses(
+      id:,
+      page: nil,
+      from: nil,
+      to: nil
+    )
+      response = client.connection.get("#{PATH}/#{id}/accesses")
+      handle_errors(response.status, response.body)
+
+      response.body
+    end
+
+    # Grant access to a customer
+    # @param id [Integer] Customer ID or Email
+    # @param product_id [Integer] Product ID
+    # @param product_type [String] Uscreen system product type. Can be a program|recurring|rent|freebie|fixed_price
+    # @param perform_action_at [String] Seconds since the Epoch. Next perform action needed in case of rent or recurring product types. System will add next due automatically in case of a blank field. example: 2024-07-05T13:47:52Z
+    # @param with_manual_billing [Boolean] Allows you to process billing outside the Uscreen platform. Default false.
+    def grant_access(
+      id:,
+      product_id:,
+      product_type:,
+      perform_action_at: nil,
+      with_manual_billing: false
+    )
+      response = client.connection.post("#{PATH}/#{id}/accesses") do |req|
+        req.body = {
+          product_id: product_id,
+          product_type: product_type,
+          with_manual_billing: with_manual_billing
+        }
+        req.body["perform_action_at"] = perform_action_at if perform_action_at
+      end
+
+      handle_errors(response.status, response.body)
+
+      response.body
+    end
+
+    # Revoke access by ID
+    # @param id [Integer] Customer ID or Email
+    # @param access_id [Integer] Access ID
+    def revoke_access(
+      id:,
+      access_id:
+    )
+      response = client.connection.delete("#{PATH}/#{id}/accesses/#{access_id}")
+      handle_errors(response.status, response.body)
+
+      response.body
+    end
+  end
+end

data/lib/uscreen_api/errors.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+module UscreenAPI::Errors
+  class UserNotFound < StandardError; end
+
+  class UserNotCreated < StandardError; end
+
+  class Unauthorized < StandardError; end
+end

data/lib/uscreen_api/version.rb

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

data/lib/uscreen_api.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+require_relative "uscreen_api/version"
+
+module UscreenAPI
+  autoload :Base, "uscreen_api/base"
+  autoload :Client, "uscreen_api/client"
+  autoload :Customers, "uscreen_api/customers"
+  autoload :Errors, "uscreen_api/errors"
+end

data/sig/uscreen_api.rbs

@@ -0,0 +1,4 @@
+module UscreenAPI
+  VERSION: String
+  # See the writing guide of rbs: https://github.com/ruby/rbs#guides
+end

metadata

@@ -0,0 +1,94 @@
+--- !ruby/object:Gem::Specification
+name: uscreen_api
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Andrei Bondarev
+bindir: exe
+cert_chain: []
+date: 2025-01-07 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: faraday
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: pry-byebug
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: yard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Uscreen.tv Publisher API client
+email:
+- andrei.bondarev13@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE.txt
+- README.md
+- lib/uscreen_api.rb
+- lib/uscreen_api/base.rb
+- lib/uscreen_api/client.rb
+- lib/uscreen_api/customers.rb
+- lib/uscreen_api/errors.rb
+- lib/uscreen_api/version.rb
+- sig/uscreen_api.rbs
+homepage: https://github.com/andreibondarev/uscreen_api
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/andreibondarev/uscreen_api
+  source_code_uri: https://github.com/andreibondarev/uscreen_api
+  changelog_uri: https://github.com/andreibondarev/uscreen_api/CHANGELOG.md
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 3.0.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.6.2
+specification_version: 4
+summary: Uscreen.tv Publisher API client
+test_files: []