gumroad-api 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 0eeff5575149fce5619a86357619efcbbbbfe5bd8fa86c30942dd85860ad191a
+  data.tar.gz: 43ccb96cd7419e7d98066d8d0f4c70171c4b4e54c68eedda087644dfe4e3a4d2
+SHA512:
+  metadata.gz: 4b63325534696aaffa9fd0cb2af7426e5c5f3ae1803a2ababa5891ddf335a797f1aa6d158eb79b4cfb5cc39cefd5a5b92cd90420b48fb0bc18dcdc7785f2f5cc
+  data.tar.gz: 906c311278aac8087f8e90a62cd2f7232653bf449d51ab5ded955409f39592a69e7303b0087ccc891cbeff91835b7d5fd95b4c356778fd5e687ce9c3db8901df

data/.rspec

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

data/.rubocop.yml

@@ -0,0 +1,20 @@
+AllCops:
+  TargetRubyVersion: 2.6
+  NewCops: enable
+
+Style/StringLiterals:
+  Enabled: true
+  EnforcedStyle: double_quotes
+
+Style/FormatString:
+  Enabled: false
+
+Style/StringLiteralsInInterpolation:
+  Enabled: true
+  EnforcedStyle: double_quotes
+
+Layout/LineLength:
+  Max: 120
+
+Metrics/BlockLength:
+  Enabled: false

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+## [Unreleased]
+
+## [0.1.0] - 2024-02-20
+
+- Initial release

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,84 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+We as members, contributors, and leaders pledge to make participation in our community a harassment-free experience for everyone, regardless of age, body size, visible or invisible disability, ethnicity, sex characteristics, gender identity and expression, level of experience, education, socio-economic status, nationality, personal appearance, race, religion, or sexual identity and orientation.
+
+We pledge to act and interact in ways that contribute to an open, welcoming, diverse, inclusive, and healthy community.
+
+## Our Standards
+
+Examples of behavior that contributes to a positive environment for our community include:
+
+* Demonstrating empathy and kindness toward other people
+* Being respectful of differing opinions, viewpoints, and experiences
+* Giving and gracefully accepting constructive feedback
+* Accepting responsibility and apologizing to those affected by our mistakes, and learning from the experience
+* Focusing on what is best not just for us as individuals, but for the overall community
+
+Examples of unacceptable behavior include:
+
+* The use of sexualized language or imagery, and sexual attention or
+  advances of any kind
+* Trolling, insulting or derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or email
+  address, without their explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Enforcement Responsibilities
+
+Community leaders are responsible for clarifying and enforcing our standards of acceptable behavior and will take appropriate and fair corrective action in response to any behavior that they deem inappropriate, threatening, offensive, or harmful.
+
+Community leaders 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, and will communicate reasons for moderation decisions when appropriate.
+
+## Scope
+
+This Code of Conduct applies within all community spaces, and also applies when an individual is officially representing the community in public spaces. Examples of representing our community include using an official e-mail address, posting via an official social media account, or acting as an appointed representative at an online or offline event.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported to the community leaders responsible for enforcement at mehmet.beydogan@gmail.com. All complaints will be reviewed and investigated promptly and fairly.
+
+All community leaders are obligated to respect the privacy and security of the reporter of any incident.
+
+## Enforcement Guidelines
+
+Community leaders will follow these Community Impact Guidelines in determining the consequences for any action they deem in violation of this Code of Conduct:
+
+### 1. Correction
+
+**Community Impact**: Use of inappropriate language or other behavior deemed unprofessional or unwelcome in the community.
+
+**Consequence**: A private, written warning from community leaders, providing clarity around the nature of the violation and an explanation of why the behavior was inappropriate. A public apology may be requested.
+
+### 2. Warning
+
+**Community Impact**: A violation through a single incident or series of actions.
+
+**Consequence**: A warning with consequences for continued behavior. No interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, for a specified period of time. This includes avoiding interactions in community spaces as well as external channels like social media. Violating these terms may lead to a temporary or permanent ban.
+
+### 3. Temporary Ban
+
+**Community Impact**: A serious violation of community standards, including sustained inappropriate behavior.
+
+**Consequence**: A temporary ban from any sort of interaction or public communication with the community for a specified period of time. No public or private interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, is allowed during this period. Violating these terms may lead to a permanent ban.
+
+### 4. Permanent Ban
+
+**Community Impact**: Demonstrating a pattern of violation of community standards, including sustained inappropriate behavior,  harassment of an individual, or aggression toward or disparagement of classes of individuals.
+
+**Consequence**: A permanent ban from any sort of public interaction within the community.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 2.0,
+available at https://www.contributor-covenant.org/version/2/0/code_of_conduct.html.
+
+Community Impact Guidelines were inspired by [Mozilla's code of conduct enforcement ladder](https://github.com/mozilla/diversity).
+
+[homepage]: https://www.contributor-covenant.org
+
+For answers to common questions about this code of conduct, see the FAQ at
+https://www.contributor-covenant.org/faq. Translations are available at https://www.contributor-covenant.org/translations.

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2024 Mehmet Beydogan
+
+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,63 @@
+# Gumroad API
+
+This Ruby gem provides a simple interface to interact with the [Gumroad API](https://app.gumroad.com/api).
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'gumroad-api'
+```
+
+## Configuration
+
+Before using the Gumroad API, you must configure it with your Gumroad access token. 
+This token is required for authenticating your requests to the Gumroad API.
+
+```ruby
+Gumroad::Client.access_token = 'your_access_token_here'
+```
+
+## Usage
+
+```ruby
+products = Gumroad::Product.list
+```
+
+See the [Documentation](docs/index.md) for more details.
+
+# Coverage
+
+Not all endpoints are covered yet. Here is the list of what is covered and what is not:
+
+- [x] Products
+- [ ] Variant categories
+- [ ] Offer codes
+- [ ] Custom fields
+- [ ] User
+- [ ] Resource subscriptions
+- [x] Sales
+- [ ] Subscribers
+- [ ] Licenses
+
+You can use the unimplemented endpoints as:
+
+```ruby
+Gumroad::Client.get('/products/123/subscribers')
+Gumroad::Client.post('/products/123/custom_fields', body: { name: 'field_name', type: 'text' })
+```
+
+# 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.
+
+# Contributing
+
+Bug reports and pull requests are welcome on GitHub. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the code of conduct.
+
+# License
+
+The gem is available as open source under the terms of the MIT License.

data/Rakefile

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+require "rubocop/rake_task"
+
+RuboCop::RakeTask.new
+
+task default: %i[spec rubocop]

data/docs/index.md

@@ -0,0 +1,4 @@
+## Usage Documentation
+
+- [Products](products.md)
+- [Sales](sales.md)

data/docs/products.md

@@ -0,0 +1,31 @@
+## Products
+
+#### Listing Products
+
+```ruby
+products = Gumroad::Product.list
+```
+
+#### Retrieving a Product
+
+```ruby
+product = Gumroad::Product.retrieve('product_id')
+```
+
+#### Deleting a Product
+
+```ruby
+Gumroad::Product.destroy('product_id')
+```
+
+#### Enabling a Product
+
+```ruby
+Gumroad::Product.enable('product_id')
+```
+
+#### Disabling a Product
+
+```ruby
+Gumroad::Product.disable('product_id')
+```

data/docs/sales.md

@@ -0,0 +1,63 @@
+## Sales
+
+#### Listing Sales
+
+It returns a tuple with the sales and the next page key for pagination.
+```ruby
+sales, next_page = Gumroad::Sale.list
+
+sales.each do |sale|
+  sale.id # => 'sale_id'
+  sale.product_id # => 'product_id'
+end
+```
+
+You can also use the filters:
+
+```ruby
+sales, next_page = Gumroad::Sale.list(product_id: 'product_id', before: '2016-01-01', after: '2015-01-01')
+```
+
+You can also use the page_key to get the next page of sales:
+
+```ruby
+sales, next_page = Gumroad::Sale.list(page_key: next_page)
+```
+
+#### Retrieving a Sale
+
+```ruby
+sale = Gumroad::Sale.retrieve('sale_id')
+
+sale.id # => 'sale_id'
+sale.product_id # => 'product_id'
+```
+
+#### Marking a Sale as Shipped
+
+```ruby
+sale = Gumroad::Sale.mark_as_shipped('sale_id')
+
+sale.success? # => true
+```
+or with tracking url
+```ruby
+sale = Gumroad::Sale.mark_as_shipped('sale_id', tracking_url: 'http://example.com/tracking')
+
+sale.success? # => true
+```
+
+#### Refunding a Sale
+
+```ruby
+sale = Gumroad::Sale.refund('sale_id')
+
+sale.success? # => true
+```
+or partial refund with `amount_cents`
+
+```ruby
+sale = Gumroad::Sale.refund('sale_id', amount_cents: 1000)
+
+sale.partially_refunded # => true
+```

data/gumroad-api.gemspec

@@ -0,0 +1,39 @@
+# frozen_string_literal: true
+
+require_relative "lib/gumroad/version"
+
+Gem::Specification.new do |spec|
+  spec.name = "gumroad-api"
+  spec.version = Gumroad::Api::VERSION
+  spec.authors = ["Mehmet Beydogan"]
+  spec.email = ["mehmet.beydogan@gmail.com"]
+
+  spec.summary = "Gumroad API client"
+  spec.description = "A simple Ruby client for the Gumroad API."
+  spec.homepage = "https://github.com/beydogan/gumroad-api"
+  spec.license = "MIT"
+  spec.required_ruby_version = ">= 2.6.0"
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = "https://github.com/beydogan/gumroad-api"
+  spec.metadata["changelog_uri"] = "https://github.com/beydogan/gumroad-api"
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files = Dir.chdir(__dir__) do
+    `git ls-files -z`.split("\x0").reject do |f|
+      (File.expand_path(f) == __FILE__) ||
+        f.start_with?(*%w[bin/ test/ spec/ features/ .git .github appveyor Gemfile])
+    end
+  end
+  spec.bindir = "exe"
+  spec.executables = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  # Uncomment to register a new dependency of your gem
+  # spec.add_dependency "example-gem", "~> 1.0"
+
+  # For more information and examples about making a new gem, check out our
+  # guide at: https://bundler.io/guides/creating_gem.html
+  spec.metadata["rubygems_mfa_required"] = "true"
+end

data/lib/gumroad/client.rb

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+require "httparty"
+
+module Gumroad
+  # The base class for Gumroad API client.
+  class Client
+    include HTTParty
+    base_uri "https://api.gumroad.com/v2"
+
+    def self.access_token=(token)
+      default_params access_token: token
+    end
+  end
+
+  # Represents success or error message from the Gumroad API.
+  class Message
+    attr_accessor :success, :message
+
+    def initialize(attributes = {})
+      attributes.each do |key, value|
+        instance_variable_set("@#{key}", value)
+      end
+    end
+
+    def success?
+      success
+    end
+  end
+end

data/lib/gumroad/product.rb

@@ -0,0 +1,59 @@
+# frozen_string_literal: true
+
+module Gumroad
+  # Represents a Product resource from the Gumroad API.
+  # For more information, refer to the Gumroad API documentation on Products:
+  # https://gumroad.com/api#products
+  class Product < Resource
+    # Accessors for product attributes
+    attr_accessor :id, :name, :description, :price, :currency, :url, :thumbnail_url, :custom_fields
+
+    # Lists all products associated with the Gumroad account.
+    # @see https://app.gumroad.com/api#get-/products
+    # @return [Array<Product>] an array of Product instances.
+    # @return [Message] when the request fails.
+    def self.list
+      handle_resource_response get("/products")
+    end
+
+    # Retrieves the details of a single product by its ID.
+    # @see https://app.gumroad.com/api#get-/products/:id
+    # @param id [String] the ID of the product to retrieve.
+    # @return [Product] an instance of Product with the retrieved details.
+    # @return [Message] when the request fails.
+    def self.retrieve(id)
+      handle_resource_response get("/products/%s" % id)
+    end
+
+    # Deletes a product by its ID.
+    # @param id [String] the ID of the product to delete.
+    # @return [Message] the response from the API after deleting the product.
+    def self.destroy(id)
+      handle_delete_response delete("/products/%s" % id)
+    end
+
+    # Enables a product by its ID, making it available for sale.
+    # @param id [String] the ID of the product to enable.
+    # @return [Product] the updated Product instance, marked as enabled.
+    # @return [Message] when the request fails.
+    def self.enable(id)
+      handle_resource_response put("/products/%s/enable" % id)
+    end
+
+    # Disables a product by its ID, making it unavailable for sale.
+    # @param id [String] the ID of the product to disable.
+    # @return [Product] the updated Product instance, marked as disabled.
+    # @return [Message] when the request fails.
+    def self.disable(id)
+      handle_resource_response put("/products/%s/disable" % id)
+    end
+
+    def self.convert_to_resource_object(response)
+      if response["products"]
+        response["products"].map { |product| new(product) }
+      else
+        new(response["product"])
+      end
+    end
+  end
+end

data/lib/gumroad/resource.rb

@@ -0,0 +1,40 @@
+# frozen_string_literal: true
+
+module Gumroad
+  # The base class for all Gumroad API resources.
+  class Resource < Client
+    attr_accessor :success
+
+    def initialize(attributes = {})
+      super()
+
+      attributes.each do |key, value|
+        self.class.send(:attr_accessor, key)
+        instance_variable_set("@#{key}", value)
+      end
+
+      @success = true
+    end
+
+    def success?
+      success
+    end
+
+    def self.handle_delete_response(response)
+      raise response unless response.success?
+
+      Message.new(response)
+    end
+
+    # @return [anything]
+    def self.handle_resource_response(response)
+      if response.success? && response["success"]
+        convert_to_resource_object(response)
+      elsif response.success? && !response["success"]
+        Message.new(response)
+      else
+        raise response.response
+      end
+    end
+  end
+end

data/lib/gumroad/sale.rb

@@ -0,0 +1,60 @@
+# frozen_string_literal: true
+
+module Gumroad
+  # Represents a Sale resource from the Gumroad API.
+  # For more information, refer to the Gumroad API documentation on Products:
+  # https://gumroad.com/api#sales
+  class Sale < Resource
+    # Lists all sales associated with the Gumroad account.
+    # @see https://app.gumroad.com/api#get-/sales
+    # @param params [Hash] a hash of query parameters to filter the list of sales.
+    #   @option params [String] :after (optional) Only return sales after this date in the form YYYY-MM-DD.
+    #   @option params [String] :before (optional) Only return sales before this date in the form YYYY-MM-DD.
+    #   @option params [String] :product_id (optional) Filter sales by this product ID.
+    #   @option params [String] :email (optional) Filter sales by this email.
+    #   @option params [String] :order_id (optional) Filter sales by this Order ID.
+    #   @option params [String] :page_key (optional) A key representing a page of results.
+    # @return [Array[Array<Product>, String] an array of Sale instances and the next page key as tuple.
+    # @return [Message] when the request fails.
+    def self.list(params = {})
+      handle_resource_response get("/sales", query: params)
+    end
+
+    # Retrieves the details of a single sale by its ID.
+    # @see https://app.gumroad.com/api#get-/sales/:id
+    # @param id [String] the ID of the sale to retrieve.
+    # @return [Sale] an instance of Sale with the retrieved details.
+    def self.retrieve(id)
+      handle_resource_response get("/sales/%s" % id)
+    end
+
+    # Marks a sale as shipped. Available with the 'mark_sales_as_shipped' scope.
+    # @see https://app.gumroad.com/api#put-/sales/:id/mark_as_shipped
+    # @param id [String] the ID of the sale to mark as shipped.
+    # @param params [Hash] a hash of parameters to mark the sale as shipped.
+    #  @option params [String] :tracking_number (optional) The tracking number for the shipment.
+    # @return [Sale] the updated Sale instance, marked as shipped.
+    def self.mark_as_shipped(id, params = {})
+      handle_resource_response put("/sales/%s/mark_as_shipped" % id, body: params)
+    end
+
+    # Refunds a sale. Available with the 'refund_sales' scope.
+    # @see https://app.gumroad.com/api#put-/sales/:id/refund
+    # @param id [String] the ID of the sale to refund.
+    # @param params [Hash] a hash of parameters to refund the sale.
+    # @option params [String] :amount_cents (optional) The amount to refund.
+    # @return [Sale] the updated Sale instance, marked as refunded.
+    def self.refund(id, params = {})
+      handle_resource_response put("/sales/%s/refund" % id, body: params)
+    end
+
+    # @return [anything]
+    def self.convert_to_resource_object(response)
+      if response["sales"]
+        [response["sales"].map { |product| new(product) }, response["next_page_key"]]
+      else
+        new(response["sale"])
+      end
+    end
+  end
+end

data/lib/gumroad/version.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module Gumroad
+  module Api
+    VERSION = "0.1.0"
+  end
+end

data/lib/gumroad.rb

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+require_relative "gumroad/client"
+require_relative "gumroad/resource"
+require_relative "gumroad/product"
+require_relative "gumroad/sale"

metadata

@@ -0,0 +1,64 @@
+--- !ruby/object:Gem::Specification
+name: gumroad-api
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Mehmet Beydogan
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2024-02-21 00:00:00.000000000 Z
+dependencies: []
+description: A simple Ruby client for the Gumroad API.
+email:
+- mehmet.beydogan@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".rspec"
+- ".rubocop.yml"
+- CHANGELOG.md
+- CODE_OF_CONDUCT.md
+- LICENSE.txt
+- README.md
+- Rakefile
+- docs/index.md
+- docs/products.md
+- docs/sales.md
+- gumroad-api.gemspec
+- lib/gumroad.rb
+- lib/gumroad/client.rb
+- lib/gumroad/product.rb
+- lib/gumroad/resource.rb
+- lib/gumroad/sale.rb
+- lib/gumroad/version.rb
+homepage: https://github.com/beydogan/gumroad-api
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/beydogan/gumroad-api
+  source_code_uri: https://github.com/beydogan/gumroad-api
+  changelog_uri: https://github.com/beydogan/gumroad-api
+  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: 2.6.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.5.3
+signing_key:
+specification_version: 4
+summary: Gumroad API client
+test_files: []