voice-notes-ruby 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 5e5fda5d02e233e1e380c996612f95f2bd966ec00153843161968baea4811fa7
+  data.tar.gz: 790e5006c44571f29242e77ad0d48a6da76e31089c26a24d87052f9f4b007526
+SHA512:
+  metadata.gz: a2b9da816d90eda694ab8203f401c1738e755d6185bf4fa372b9601a84dabc2f98bd093b60ecff29c475ee173402d662a588edfa10b1723c31a2b7e039493fe8
+  data.tar.gz: 2b5297aea223626b1a1d2bb1e7ec179d01babc1ccb5d67491114b15676a6b6bbbc2dc6d3cbd0ad8983d5a6d1646588f0315dedaea85ecdd3f3ef45cbc15bfd4e

data/.rspec

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

data/.rubocop.yml

@@ -0,0 +1,39 @@
+AllCops:
+  NewCops: enable
+  TargetRubyVersion: 3.2
+  SuggestExtensions: false
+  Exclude:
+    - 'bin/*'
+    - 'vendor/**/*'
+
+Style/StringLiterals:
+  EnforcedStyle: double_quotes
+
+Style/StringLiteralsInInterpolation:
+  EnforcedStyle: double_quotes
+
+Style/Documentation:
+  Enabled: false
+
+Metrics/BlockLength:
+  Exclude:
+    - 'spec/**/*'
+    - '*.gemspec'
+
+Metrics/MethodLength:
+  Max: 20
+
+Layout/LineLength:
+  Max: 120
+
+Metrics/AbcSize:
+  Max: 25
+
+Metrics/CyclomaticComplexity:
+  Max: 12
+
+Gemspec/DevelopmentDependencies:
+  Enabled: false
+
+Gemspec/RequiredRubyVersion:
+  Enabled: false

data/.ruby-version

@@ -0,0 +1 @@
+3.3.5

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2024 Voice Notes
+
+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,108 @@
+# Voice Notes Ruby
+
+Ruby client for the Voice Notes API.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'voice-notes-ruby'
+```
+
+And then execute:
+
+```bash
+bundle install
+```
+
+Or install it yourself as:
+
+```bash
+gem install voice-notes-ruby
+```
+
+## Configuration
+
+```ruby
+VoiceNotes.configure do |config|
+  config.api_key = "your_access_token"
+  config.base_url = "https://voice-notes.online"  # optional, this is the default
+  config.timeout = 30  # optional, in seconds
+end
+```
+
+Or set via environment variables:
+
+```bash
+export VOICE_NOTES_API_KEY="your_access_token"
+```
+
+## Usage
+
+### Authentication
+
+```ruby
+require "voice_notes"
+
+client = VoiceNotes.client
+
+# Login with email and password
+response = client.auth.login(email: "user@example.com", password: "password123")
+access_token = response["access_token"]
+refresh_token = response["refresh_token"]
+
+# Set the access token for subsequent requests
+client.access_token = access_token
+
+# Get current user info
+me = client.auth.me
+puts me["data"]["attributes"]["email"]
+
+# Refresh access token when expired
+new_tokens = client.auth.refresh(refresh_token: refresh_token)
+client.access_token = new_tokens["access_token"]
+
+# Logout
+client.auth.logout
+```
+
+### Notes
+
+```ruby
+# Retrieve a note by its short ID
+note = client.notes.find("abc123")
+
+puts note["data"]["attributes"]["site_url"]
+puts note["data"]["attributes"]["recording_url"]
+```
+
+### Error Handling
+
+```ruby
+begin
+  note = client.notes.find("nonexistent")
+rescue VoiceNotes::NotFoundError
+  puts "Note not found"
+rescue VoiceNotes::AuthenticationError
+  puts "Invalid or expired token"
+rescue VoiceNotes::AuthorizationError
+  puts "Access forbidden"
+rescue VoiceNotes::ValidationError => e
+  puts "Validation error: #{e.message}"
+rescue VoiceNotes::RateLimitError
+  puts "Rate limit exceeded, try again later"
+rescue VoiceNotes::ServerError
+  puts "Server error, try again later"
+end
+```
+
+## 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`.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

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

data/lib/voice_notes/client.rb

@@ -0,0 +1,109 @@
+# frozen_string_literal: true
+
+require "net/http"
+require "json"
+require "uri"
+
+module VoiceNotes
+  class Client
+    attr_accessor :access_token
+
+    def initialize(access_token: nil, base_url: nil)
+      @access_token = access_token || VoiceNotes.configuration&.api_key
+      @base_url = base_url || VoiceNotes.configuration&.base_url
+    end
+
+    def auth
+      @auth ||= Resources::Auth.new(self)
+    end
+
+    def notes
+      @notes ||= Resources::Notes.new(self)
+    end
+
+    def get(path, params = {})
+      request(:get, path, params)
+    end
+
+    def post(path, body = {})
+      request(:post, path, body)
+    end
+
+    def put(path, body = {})
+      request(:put, path, body)
+    end
+
+    def delete(path)
+      request(:delete, path)
+    end
+
+    private
+
+    attr_reader :base_url
+
+    def request(method, path, data = {})
+      uri = URI.join(base_url, path)
+
+      uri.query = URI.encode_www_form(data) if method == :get && !data.empty?
+
+      http = Net::HTTP.new(uri.host, uri.port)
+      http.use_ssl = uri.scheme == "https"
+      http.read_timeout = VoiceNotes.configuration&.timeout || 30
+
+      request = build_request(method, uri, data)
+      response = http.request(request)
+
+      handle_response(response)
+    end
+
+    def build_request(method, uri, data)
+      request_class = {
+        get: Net::HTTP::Get,
+        post: Net::HTTP::Post,
+        put: Net::HTTP::Put,
+        delete: Net::HTTP::Delete
+      }.fetch(method)
+
+      request = request_class.new(uri)
+      request["Authorization"] = "Bearer #{access_token}" if access_token
+      request["Content-Type"] = "application/json"
+      request["Accept"] = "application/vnd.api+json"
+
+      request.body = JSON.generate(data) if %i[post put].include?(method) && !data.empty?
+
+      request
+    end
+
+    def handle_response(response)
+      case response.code.to_i
+      when 200..299
+        JSON.parse(response.body) unless response.body.nil? || response.body.empty?
+      when 401
+        raise AuthenticationError, "Invalid or expired token"
+      when 403
+        raise AuthorizationError, "Access forbidden"
+      when 404
+        raise NotFoundError, "Resource not found"
+      when 422
+        raise ValidationError, parse_error_message(response)
+      when 429
+        raise RateLimitError, "Rate limit exceeded"
+      when 500..599
+        raise ServerError, "Server error: #{response.code}"
+      else
+        raise Error, "Unexpected response: #{response.code}"
+      end
+    end
+
+    def parse_error_message(response)
+      body = JSON.parse(response.body)
+      if body["errors"]&.first
+        body["errors"].first["detail"] || body["errors"].first["title"]
+      else
+        body["error"] || body["message"] || "Validation failed"
+      end
+    rescue JSON::ParserError
+      "Validation failed"
+    end
+  end
+end

data/lib/voice_notes/configuration.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module VoiceNotes
+  class Configuration
+    attr_accessor :api_key, :base_url, :timeout
+
+    def initialize
+      @api_key = ENV.fetch("VOICE_NOTES_API_KEY", nil)
+      @base_url = ENV.fetch("VOICE_NOTES_BASE_URL", "https://voice-notes.online")
+      @timeout = 30
+    end
+  end
+end

data/lib/voice_notes/error.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module VoiceNotes
+  class Error < StandardError; end
+  class AuthenticationError < Error; end
+  class AuthorizationError < Error; end
+  class NotFoundError < Error; end
+  class ValidationError < Error; end
+  class RateLimitError < Error; end
+  class ServerError < Error; end
+end

data/lib/voice_notes/resources/auth.rb

@@ -0,0 +1,41 @@
+# frozen_string_literal: true
+
+module VoiceNotes
+  module Resources
+    class Auth < Base
+      # Login with email and password
+      # @param email [String] User's email
+      # @param password [String] User's password
+      # @return [Hash] Response containing access_token and refresh_token
+      def login(email:, password:)
+        post("/api/v1/auth/login", {
+               email: email,
+               password: password,
+               grant_type: "password"
+             })
+      end
+
+      # Refresh access token using refresh token
+      # @param refresh_token [String] The refresh token
+      # @return [Hash] Response containing new access_token and refresh_token
+      def refresh(refresh_token:)
+        post("/api/v1/auth/login", {
+               grant_type: "refresh_token",
+               refresh_token: refresh_token
+             })
+      end
+
+      # Logout and invalidate the current session
+      # @return [Hash, nil] Response from server
+      def logout
+        delete("/api/v1/auth/logout")
+      end
+
+      # Get current authenticated user
+      # @return [Hash] User data in JSON:API format
+      def me
+        get("/api/v1/me")
+      end
+    end
+  end
+end

data/lib/voice_notes/resources/base.rb

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+module VoiceNotes
+  module Resources
+    class Base
+      attr_reader :client
+
+      def initialize(client)
+        @client = client
+      end
+
+      private
+
+      def get(path, params = {})
+        client.get(path, params)
+      end
+
+      def post(path, body = {})
+        client.post(path, body)
+      end
+
+      def put(path, body = {})
+        client.put(path, body)
+      end
+
+      def delete(path)
+        client.delete(path)
+      end
+    end
+  end
+end

data/lib/voice_notes/resources/notes.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module VoiceNotes
+  module Resources
+    class Notes < Base
+      # Retrieve a voice note by its short ID
+      # @param id [String] The Base58 short ID of the note
+      # @return [Hash] Note data in JSON:API format
+      def find(id)
+        get("/api/v1/notes/#{id}")
+      end
+    end
+  end
+end

data/lib/voice_notes/version.rb

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

data/lib/voice_notes.rb

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+require_relative "voice_notes/version"
+require_relative "voice_notes/configuration"
+require_relative "voice_notes/error"
+require_relative "voice_notes/client"
+require_relative "voice_notes/resources/base"
+require_relative "voice_notes/resources/auth"
+require_relative "voice_notes/resources/notes"
+
+module VoiceNotes
+  class << self
+    attr_accessor :configuration
+  end
+
+  def self.configure
+    self.configuration ||= Configuration.new
+    yield(configuration)
+  end
+
+  def self.client
+    @client ||= Client.new
+  end
+
+  def self.reset!
+    @client = nil
+    @configuration = nil
+  end
+end

data/voice-notes-ruby.gemspec

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+
+require_relative "lib/voice_notes/version"
+
+Gem::Specification.new do |spec|
+  spec.name = "voice-notes-ruby"
+  spec.version = VoiceNotes::VERSION
+  spec.authors = ["Voice Notes"]
+  spec.email = ["support@voice-notes.online"]
+
+  spec.summary = "Ruby client for the Voice Notes API"
+  spec.description = "Official Ruby client library for interacting with the Voice Notes API"
+  spec.homepage = "https://github.com/voice-notes-online/voice-notes-ruby"
+  spec.license = "MIT"
+  spec.required_ruby_version = ">= 3.0.0"
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = spec.homepage
+  spec.metadata["changelog_uri"] = "#{spec.homepage}/blob/master/CHANGELOG.md"
+  spec.metadata["rubygems_mfa_required"] = "true"
+
+  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"]
+
+  spec.add_development_dependency "bundler", "~> 2.0"
+  spec.add_development_dependency "rake", "~> 13.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency "rubocop", "~> 1.21"
+  spec.add_development_dependency "webmock", "~> 3.18"
+end

metadata

@@ -0,0 +1,132 @@
+--- !ruby/object:Gem::Specification
+name: voice-notes-ruby
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Voice Notes
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2025-11-28 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.21'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.21'
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.18'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.18'
+description: Official Ruby client library for interacting with the Voice Notes API
+email:
+- support@voice-notes.online
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".rspec"
+- ".rubocop.yml"
+- ".ruby-version"
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/voice_notes.rb
+- lib/voice_notes/client.rb
+- lib/voice_notes/configuration.rb
+- lib/voice_notes/error.rb
+- lib/voice_notes/resources/auth.rb
+- lib/voice_notes/resources/base.rb
+- lib/voice_notes/resources/notes.rb
+- lib/voice_notes/version.rb
+- voice-notes-ruby.gemspec
+homepage: https://github.com/voice-notes-online/voice-notes-ruby
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/voice-notes-online/voice-notes-ruby
+  source_code_uri: https://github.com/voice-notes-online/voice-notes-ruby
+  changelog_uri: https://github.com/voice-notes-online/voice-notes-ruby/blob/master/CHANGELOG.md
+  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.0.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.5.16
+signing_key:
+specification_version: 4
+summary: Ruby client for the Voice Notes API
+test_files: []