pinata 1.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 4b58adb3eac2c345d9c010d8dda02f38e7a8963501dc951e8e211ae506862ad6
+  data.tar.gz: 3e63495aae0b3713ed43b3194e09273ebb3b1f8a853b5dedd25e736f7a2485d1
+SHA512:
+  metadata.gz: 8d75e436576b230350bbe0a0f3d19304ecebe1ff6ad336aa0e6d0960e46cc0b8a25e03900322a5b6f97cc4856dc3841dad84155170179ac249c74e9444d7c942
+  data.tar.gz: 5e01a7b68ebe411720ebdd969a01088894d7d29e8827981df4dbc2bc95cf4ab3778387896a2a0a15fd94aa16d1c56995ee8f33dd265355ef9668f259780a4b72

data/.ruby-version

@@ -0,0 +1 @@
+3.2.3

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+## [Unreleased]
+
+## [0.1.0] - 2024-11-13
+
+- 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 contact@onyxmueller.net. 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 Onyx Mueller
+
+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,109 @@
+# Pinata
+
+[![Build Status](https://github.com/onyxmueller/pinata-ruby/actions/workflows/build.yml/badge.svg)](https://github.com/onyxmueller/pinata-ruby/actions/workflows/build.yml)
+
+![header](https://docs.mypinata.cloud/ipfs/QmP9PGe3PdUqmsq8xY4sEW3qgdXx4WT9ictTWCb3qyzz3s?img-format=webp)
+
+The Pinata Ruby library provides convenient access to the Pinata API from applications written in the Ruby language. It includes a pre-defined set of classes for API resources that initialize themselves dynamically from API responses.
+
+## Documentation
+
+See the [Pinata API docs](https://docs.pinata.cloud/api-reference).
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```sh
+    gem 'pinata', github: "onyxmueller/pinata-ruby"
+```
+
+And then execute:
+
+```sh
+    bundle
+```
+
+Or install it yourself as:
+
+```sh
+    gem install pinata
+```
+
+### Requirements
+
+- Ruby 2.6+.
+
+## Usage
+
+To access the API, you'll need to create a `Pinata::Client` and pass in your API key. You can find your API key at [https://app.pinata.cloud/developers/api-keys](https://app.pinata.cloud/developers/api-keys).
+
+```ruby
+    client = Pinata::Client.new(jwt_key: ENV["PINATA_JWT"])
+```
+
+## Resources
+
+The gem maps as closely as we can to the Pinata API so you can easily convert API examples to gem code.
+
+Responses are created as objects like `Pinata::File`. They're built using [OpenStruct](https://github.com/ruby/ostruct) so you can easily access data in a Ruby-ish way.
+
+### Pagination
+
+ `List` endpoints return pages of results. The result object will have a `data` key to access the results, as well as metadata like `next_page_token` for retrieving the next page.
+
+```ruby
+results = client.files.list
+#=> Pinata::Collection
+
+results.data.size
+#=> 48
+
+results.data
+#=> [#<Pinata::File>, #<Pinata::File>]
+
+results.next_page_token
+#=> "MDE5MzJjNzctMDg2Ny03ZTdhLWE2ZDEtMDRhZWRlZDNjMWI5"
+
+# Retrieve the next page
+client.files.list(pageToken: "MDE5MzJjNzctMDg2Ny03ZTdhLWE2ZDEtMDRhZWRlZDNjMWI5")
+#=> Pinata::Collection
+```
+
+### Authentication
+
+```ruby
+client.authentication.test
+```
+
+### Files
+
+```ruby
+client.files.upload(file: "/path/to/file")
+client.files.list
+client.files.list("metadata[key]": "value")
+client.files.update(file_id: "thefileid", "name": "thenameoffile")
+client.files.sign("gateway": "yourgatewaydomain", "file_cid": "thefilecid", "expires": 500000)
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. 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
+
+1. Fork it ( [https://github.com/onyxmueller/pinata-ruby/fork](https://github.com/onyxmueller/pinata-ruby/fork) )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the Pinata project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/onyxmueller/pinata-ruby/blob/main/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+task default: %i[standard test]
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList["test/**/*_test.rb"]
+end
+
+task :standard do
+  exec "standardrb"
+end

data/lib/pinata/client.rb

@@ -0,0 +1,60 @@
+# frozen_string_literal: true
+
+module Pinata
+  class Client
+    API_VERSION = "v3"
+    BASE_DOMAIN = "pinata.cloud"
+    API_BASE_URL = "https://api.#{BASE_DOMAIN}/"
+    API_URL = "#{API_BASE_URL}#{API_VERSION}/"
+    UPLOADS_URL = "https://uploads.#{BASE_DOMAIN}/#{API_VERSION}/"
+
+    attr_reader :pinata_jwt, :adapter
+
+    def initialize(pinata_jwt:, adapter: Faraday.default_adapter, stubs: nil)
+      @pinata_jwt = pinata_jwt
+      @adapter = adapter
+
+      # Test stubs for requests
+      @stubs = stubs
+    end
+
+    def authentication
+      AuthenticationResource.new(self)
+    end
+
+    def files
+      FilesResource.new(self)
+    end
+
+    def test_connection
+      @test_connection ||= Faraday.new(url: API_BASE_URL) do |conn|
+        conn.request :authorization, :Bearer, pinata_jwt
+        conn.response :json, content_type: "application/json"
+        conn.adapter adapter, @stubs
+      end
+    end
+
+    def upload_connection
+      @upload_connection ||= Faraday.new(url: UPLOADS_URL) do |conn|
+        conn.request :authorization, :Bearer, pinata_jwt
+        conn.request :multipart
+        conn.request :json
+        conn.response :json, content_type: "application/json"
+        conn.adapter adapter, @stubs
+      end
+    end
+
+    def api_connection
+      @api_connection ||= Faraday.new(url: API_URL) do |conn|
+        conn.request :authorization, :Bearer, pinata_jwt
+        conn.request :json
+        conn.response :json, content_type: "application/json"
+        conn.adapter adapter, @stubs
+      end
+    end
+
+    def inspect
+      "#<Pinata::Client>"
+    end
+  end
+end

data/lib/pinata/collection.rb

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+module Pinata
+  class Collection
+    attr_reader :data, :next_page_token
+
+    def self.from_response(response, key:, type:)
+      body = response.body
+      new(
+        data: body["data"][key].map { |attrs| type.new(attrs) },
+        next_page_token: body.dig("data", "next_page_token")
+      )
+    end
+
+    def initialize(data:, next_page_token:)
+      @data = data
+      @next_page_token = (next_page_token.nil? || next_page_token.empty?) ? nil : next_page_token
+    end
+
+    def empty?
+      data.empty?
+    end
+
+    def sample
+      data.sample
+    end
+  end
+end

data/lib/pinata/error.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module Pinata
+  class Error < StandardError; end
+end

data/lib/pinata/object.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+require "ostruct"
+
+module Pinata
+  class Object < OpenStruct
+    def initialize(attributes)
+      super(to_ostruct(attributes))
+    end
+
+    def to_ostruct(obj)
+      if obj.is_a?(Hash)
+        OpenStruct.new(obj.transform_values { |val| to_ostruct(val) })
+      elsif obj.is_a?(Array)
+        obj.map { |o| to_ostruct(o) }
+      else # Assumed to be a primitive value
+        obj
+      end
+    end
+  end
+end

data/lib/pinata/objects/file.rb

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+module Pinata
+  class File < Object
+  end
+end

data/lib/pinata/resource.rb

@@ -0,0 +1,63 @@
+# frozen_string_literal: true
+
+module Pinata
+  class Resource
+    attr_reader :client
+
+    def initialize(client)
+      @client = client
+    end
+
+    private
+
+    def test_get_request(url)
+      handle_response client.test_connection.get(url)
+    end
+
+    def upload_post_request(url, body:, headers: {})
+      handle_response client.upload_connection.post(url, body, headers)
+    end
+
+    def api_get_request(url, params: {}, headers: {})
+      handle_response client.api_connection.get(url, params, headers)
+    end
+
+    def api_post_request(url, body:, headers: {})
+      handle_response client.api_connection.post(url, body, headers)
+    end
+
+    def api_patch_request(url, body:, headers: {})
+      handle_response client.api_connection.patch(url, body, headers)
+    end
+
+    def api_put_request(url, body:, headers: {})
+      handle_response client.api_connection.put(url, body, headers)
+    end
+
+    def api_delete_request(url, params: {}, headers: {})
+      handle_response client.api_connection.delete(url, params, headers)
+    end
+
+    def handle_response(response)
+      case response.status
+      when 400
+        raise Error, "Your request was malformed. #{response.body["error"]}"
+      when 401
+        raise Error, "You did not supply valid authentication credentials. #{response.body["error"]}"
+      when 403
+        raise Error, "You are not allowed to perform that action. #{response.body["error"]}"
+      when 404
+        raise Error, "No results were found for your request. #{response.body["error"]}"
+      when 429
+        raise Error, "Your request exceeded the API rate limit. #{response.body["error"]}"
+      when 500
+        raise Error, "We were unable to perform the request due to server-side problems. #{response.body["error"]}"
+      when 503
+        raise Error,
+          "You have been rate limited for sending more than 20 requests per second. #{response.body["error"]}"
+      end
+
+      response
+    end
+  end
+end

data/lib/pinata/resources/authentication.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+module Pinata
+  class AuthenticationResource < Resource
+    def test
+      test_get_request("data/testAuthentication")
+    end
+  end
+end

data/lib/pinata/resources/files.rb

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+module Pinata
+  class FilesResource < Resource
+    def upload(file:, name: nil, mime_type: nil, metadata: nil)
+      mime_type ||= Marcel::MimeType.for(file)
+      payload = {file: Faraday::UploadIO.new(file, mime_type)}
+      payload[:name] = name unless name.nil?
+      payload[:keyvalues] = metadata unless metadata.nil?
+      File.new upload_post_request("files", body: payload,
+        headers: {"Content-Type" => "multipart/form-data"}).body["data"]
+    end
+
+    def list(**params)
+      response = api_get_request("files", params: params)
+      Collection.from_response(response, key: "files", type: File)
+    end
+
+    def sign(gateway:, file_cid:, expires:, date: Time.now.to_i,
+      url_method: "GET")
+      payload = {
+        url: "https://#{gateway}/files/#{file_cid}",
+        date: date,
+        expires: expires,
+        method: url_method
+      }
+      api_post_request("files/sign", body: payload).body["data"]
+    end
+
+    def update(file_id:, **attributes)
+      File.new api_put_request("files/#{file_id}", body: attributes).body["data"]
+    end
+  end
+end

data/lib/pinata/version.rb

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

data/lib/pinata.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+# Pinata Ruby bindings
+# API spec at https://docs.pinata.cloud/api-reference/
+require "faraday"
+require "faraday/multipart"
+require "marcel"
+require "pinata/version"
+
+module Pinata
+  autoload :Client, "pinata/client"
+  autoload :Collection, "pinata/collection"
+  autoload :Error, "pinata/error"
+  autoload :Resource, "pinata/resource"
+  autoload :Object, "pinata/object"
+
+  autoload :AuthenticationResource, "pinata/resources/authentication"
+  autoload :FilesResource, "pinata/resources/files"
+
+  autoload :File, "pinata/objects/file"
+end

data/pinata.gemspec

@@ -0,0 +1,46 @@
+# frozen_string_literal: true
+
+lib = File.expand_path("lib", __dir__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "pinata/version"
+
+Gem::Specification.new do |spec|
+  spec.name = "pinata"
+  spec.version = Pinata::VERSION
+  spec.authors = ["Onyx Mueller"]
+  spec.email = ["contact@onyxmueller.net"]
+
+  spec.summary = "Ruby bindings for the Pinata API"
+  spec.description = "Ruby bindings for the Pinata API. More info about Pinata can be found here: https://docs.pinata.cloud/quickstart"
+  spec.homepage = "https://github.com/onyxmueller/pinata-ruby"
+  spec.license = "MIT"
+  spec.required_ruby_version = ">= 2.6.0"
+
+  # spec.metadata["allowed_push_host"] = "TODO: Set to your gem server 'https://example.com'"
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = "https://github.com/onyxmueller/pinata-ruby"
+  spec.metadata["changelog_uri"] = "https://github.com/onyxmueller/pinata-ruby/changelog.md"
+
+  # 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.add_dependency "faraday", "~> 2.12"
+  spec.add_dependency "faraday-multipart", "~> 1.0.4"
+  spec.add_dependency "marcel", "~> 1.0.4"
+end

data/sig/pinata.rbs

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

metadata

@@ -0,0 +1,107 @@
+--- !ruby/object:Gem::Specification
+name: pinata
+version: !ruby/object:Gem::Version
+  version: 1.0.1
+platform: ruby
+authors:
+- Onyx Mueller
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2024-11-18 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: faraday
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.12'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.12'
+- !ruby/object:Gem::Dependency
+  name: faraday-multipart
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.0.4
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.0.4
+- !ruby/object:Gem::Dependency
+  name: marcel
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.0.4
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.0.4
+description: 'Ruby bindings for the Pinata API. More info about Pinata can be found
+  here: https://docs.pinata.cloud/quickstart'
+email:
+- contact@onyxmueller.net
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".ruby-version"
+- CHANGELOG.md
+- CODE_OF_CONDUCT.md
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/pinata.rb
+- lib/pinata/client.rb
+- lib/pinata/collection.rb
+- lib/pinata/error.rb
+- lib/pinata/object.rb
+- lib/pinata/objects/file.rb
+- lib/pinata/resource.rb
+- lib/pinata/resources/authentication.rb
+- lib/pinata/resources/files.rb
+- lib/pinata/version.rb
+- pinata.gemspec
+- sig/pinata.rbs
+homepage: https://github.com/onyxmueller/pinata-ruby
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/onyxmueller/pinata-ruby
+  source_code_uri: https://github.com/onyxmueller/pinata-ruby
+  changelog_uri: https://github.com/onyxmueller/pinata-ruby/changelog.md
+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.4.19
+signing_key: 
+specification_version: 4
+summary: Ruby bindings for the Pinata API
+test_files: []