doohly 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: ec0740e7866069798ff27a4b45a33757d8089c6c7ebdb0f7fcc3315ddd7f02a4
+  data.tar.gz: bc19baf1010dc9f34cb1c4e2470c5e509de73276515279f5ec755c29f15c60d5
+SHA512:
+  metadata.gz: a3ac4751076638654f0c799cb0e3c7524e6bb9ae3fbea2eaac41bae07638b8962e48780912238a6b4311f4a7ffcf70ce8aa85fa9690d928d6ddf6d40af12e0b6
+  data.tar.gz: e1703715bb36cca9c54b6e29d09ab385e1e99929a59545ce0eae7cc858d6f56d17962aa5ebf018843fcca09ce118b7d5f7336c28ca04024a6ecec70546b5c712

data/.rspec

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

data/.rubocop.yml

@@ -0,0 +1,88 @@
+require:
+  - rubocop-rspec
+
+AllCops:
+  TargetRubyVersion: 3.0
+  NewCops: enable
+  SuggestExtensions: false
+  Exclude:
+    - 'vendor/**/*'
+    - 'tmp/**/*'
+    - 'bin/**/*'
+
+# Disable problematic cops
+Capybara/RSpec/PredicateMatcher:
+  Enabled: false
+
+# Style preferences
+Style/StringLiterals:
+  Enabled: true
+  EnforcedStyle: double_quotes
+
+Style/StringLiteralsInInterpolation:
+  Enabled: true
+  EnforcedStyle: double_quotes
+
+Style/Documentation:
+  Enabled: false
+
+Style/FrozenStringLiteralComment:
+  Enabled: true
+  EnforcedStyle: always
+
+# Layout preferences
+Layout/LineLength:
+  Max: 120
+  AllowedPatterns: ['\A\s*#']
+
+Layout/MultilineMethodCallIndentation:
+  Enabled: true
+  EnforcedStyle: indented
+
+# Metrics
+Metrics/BlockLength:
+  Exclude:
+    - 'spec/**/*'
+    - '*.gemspec'
+
+Metrics/MethodLength:
+  Max: 50
+
+Metrics/ClassLength:
+  Max: 200
+
+Metrics/AbcSize:
+  Max: 35
+
+Metrics/CyclomaticComplexity:
+  Max: 15
+
+Metrics/PerceivedComplexity:
+  Max: 15
+
+Metrics/ParameterLists:
+  Max: 15
+
+# RSpec specific
+RSpec/ExampleLength:
+  Max: 25
+
+RSpec/MultipleExpectations:
+  Max: 5
+
+RSpec/NestedGroups:
+  Max: 5
+
+RSpec/MultipleDescribes:
+  Enabled: false
+
+# Gemspec
+Gemspec/DevelopmentDependencies:
+  Enabled: false
+
+Naming/PredicateMethod:
+  Enabled: false
+
+# Lint
+Lint/ScriptPermission:
+  Enabled: false

data/CHANGELOG.md

@@ -0,0 +1,25 @@
+# Changelog
+
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
+and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+## [Unreleased]
+
+## [0.1.0] - 2025-11-11
+
+### Added
+- Initial release
+- Support for Doohly API v1 and v2 endpoints
+- Devices API (list, get by ID)
+- Bookings API (list, get, create, update, delete)
+- Creatives API (get signed upload URL, check upload status)
+- Configuration management
+- Comprehensive error handling
+- Full test coverage with RSpec
+- RuboCop linting configuration
+- CI/CD with GitHub Actions
+
+[Unreleased]: https://github.com/Sentia/doohly/compare/v0.1.0...HEAD
+[0.1.0]: https://github.com/Sentia/doohly/releases/tag/v0.1.0

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2025 Chayut Orapinpatipat
+
+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,214 @@
+# Doohly Ruby Client
+
+[![Gem Version](https://badge.fury.io/rb/doohly.svg)](https://badge.fury.io/rb/doohly)
+[![CI](https://github.com/Sentia/doohly/workflows/CI/badge.svg)](https://github.com/Sentia/doohly/actions)
+[![codecov](https://codecov.io/gh/Sentia/doohly-ruby/branch/main/graph/badge.svg)](https://codecov.io/gh/Sentia/doohly-ruby)
+
+A Ruby client library for the [Doohly](https://dooh.ly) Digital Out-of-Home (DOOH) advertising platform API.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'doohly'
+```
+
+And then execute:
+
+```bash
+bundle install
+```
+
+Or install it yourself as:
+
+```bash
+gem install doohly
+```
+
+## Usage
+
+### Configuration
+
+Configure the gem globally:
+
+```ruby
+require 'doohly'
+
+Doohly.configure do |config|
+  config.api_token = ENV['DOOHLY_API_TOKEN']
+  config.timeout = 30
+  config.open_timeout = 10
+  # config.logger = Logger.new(STDOUT) # Optional: Enable request logging
+end
+```
+
+Or create a client instance directly:
+
+```ruby
+client = Doohly::Client.new(api_token: 'your_api_token')
+```
+
+### Devices
+
+```ruby
+# List all devices
+devices = client.devices
+puts devices
+
+# Get a specific device
+device = client.device('device-id-123')
+puts device['name']
+puts device['isConnected']
+```
+
+### Bookings
+
+```ruby
+# List all bookings
+bookings = client.bookings
+
+# Filter bookings by status
+active_bookings = client.bookings(status: 'booked')
+
+# Get a specific booking
+booking = client.booking('booking-id-123')
+
+# Create a new booking
+new_booking = client.create_booking(
+  name: 'My Campaign',
+  status: 'draft',
+  external_id: 'campaign-001',
+  plays_per_loop: 2,
+  loops_per_play: 1,
+  play_consecutively: true,
+  purchase_type: 'Sold',
+  schedule: {
+    startDate: '2024-01-01',
+    endDate: '2024-12-31',
+    startTime: '09:00:00',
+    endTime: '18:00:00',
+    days: ['mon', 'tue', 'wed', 'thu', 'fri'],
+    timezone: 'America/New_York',
+    useLocalTime: false
+  },
+  assigned_creatives: [
+    {
+      creative: { id: 'creative-id-123' },
+      durationSource: 'custom',
+      durationMs: 15000,
+      order: 1
+    }
+  ],
+  assigned_frames: [
+    { frame: { id: 'frame-id-456' } }
+  ],
+  seedooh: {
+    enabled: false
+  }
+)
+
+# Update a booking
+updated_booking = client.update_booking(
+  'booking-id-123',
+  name: 'Updated Campaign Name',
+  status: 'booked'
+)
+
+# Delete a booking
+result = client.delete_booking('booking-id-123')
+puts "Removed from #{result['removedFromDeviceCount']} devices"
+```
+
+### Creatives
+
+```ruby
+# Get signed URL for uploading a creative
+upload_info = client.get_signed_upload_url(
+  name: 'my-video.mp4',
+  mime_type: 'video/mp4',
+  file_size: 5_242_880, # 5MB in bytes
+  playback_scaling: 'contain',
+  path: ['campaigns', '2024']
+)
+
+upload_url = upload_info['uploadUrl']
+upload_id = upload_info['id']
+
+# Upload the file to the signed URL (using your preferred HTTP client)
+require 'net/http'
+uri = URI(upload_url)
+http = Net::HTTP.new(uri.host, uri.port)
+http.use_ssl = true
+request = Net::HTTP::Put.new(uri)
+request['Content-Type'] = 'video/mp4'
+request.body = File.read('path/to/my-video.mp4')
+response = http.request(request)
+
+# Check upload status
+status = client.creative_upload_status(upload_id)
+puts status['creative']['status'] # 'pending', 'processing', or 'complete'
+```
+
+## Error Handling
+
+The gem provides specific error classes for different scenarios:
+
+```ruby
+begin
+  client.device('non-existent-id')
+rescue Doohly::NotFoundError => e
+  puts "Device not found: #{e.message}"
+  puts "Status: #{e.status}"
+rescue Doohly::AuthenticationError => e
+  puts "Authentication failed: #{e.message}"
+rescue Doohly::RateLimitError => e
+  puts "Rate limit exceeded: #{e.message}"
+rescue Doohly::APIError => e
+  puts "API error: #{e.message}"
+end
+```
+
+Available error classes:
+- `Doohly::Error` - Base error class
+- `Doohly::ConfigurationError` - Invalid configuration
+- `Doohly::APIError` - Base API error
+- `Doohly::AuthenticationError` - 401 errors
+- `Doohly::NotFoundError` - 404 errors
+- `Doohly::BadRequestError` - 400 errors
+- `Doohly::RateLimitError` - 429 errors
+- `Doohly::ServerError` - 5xx errors
+
+## 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`.
+
+### Running Tests
+
+```bash
+bundle exec rspec
+```
+
+### Linting
+
+```bash
+bundle exec rubocop
+```
+
+### Code Coverage
+
+Code coverage reports are generated automatically when running tests. Open `coverage/index.html` to view the report.
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/Sentia/doohly. This project is intended to be a safe, welcoming space for collaboration.
+
+## 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 Doohly project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/Sentia/doohly/blob/main/CODE_OF_CONDUCT.md).

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]