box_active_storage 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 56950dc6a327d09c817d1db342c167313140bdef613fb5d79ddeb2a30148ff43
+  data.tar.gz: f93aebbe4a1fc38c920afa097551fbc4bf10533a471d4cba6421e0edec8c4f0b
+SHA512:
+  metadata.gz: 35a1eeee26b0d34ee6c18d5fdfd141b9ab28ce0551ae369a80d70b47524de9c88de633487b824b46f76bf75aabf61395585fddc9de51e217c81b75bd7742c9fd
+  data.tar.gz: 4d7f6442c833b63d8a509d54cc8f7645f0e35846cc0b7e861eee7ef26655f4e25a4aa9e235a5a6a3437f1da4cb1626169dffa615b1008759649e11e1a65fa285

data/.rspec

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

data/.rubocop.yml

@@ -0,0 +1,55 @@
+# require:
+#   - rubocop-rails
+
+AllCops:
+  NewCops: enable
+
+Style/TrailingCommaInArrayLiteral:
+  Enabled: false
+
+Style/TrailingCommaInHashLiteral:
+  Enabled: false
+
+Style/TrailingCommaInArguments:
+  Enabled: false
+
+Style/FormatStringToken:
+  Enabled: false
+
+Metrics/BlockLength:
+  Max: 30
+  Exclude:
+    - spec/**/*.rb
+    - Guardfile
+
+Style/Documentation:
+  Enabled: false
+
+Layout/LineLength:
+  Max: 200
+
+Metrics/MethodLength:
+  Max: 20
+
+Rails/FilePath:
+  EnforcedStyle: arguments
+
+Metrics/AbcSize:
+  Enabled: false
+
+Metrics/ClassLength:
+  Max: 140
+
+Layout/EndAlignment:
+  EnforcedStyleAlignWith: variable
+  Enabled: true
+
+Layout/MultilineMethodCallIndentation:
+  EnforcedStyle: indented
+  Enabled: true
+
+Rails/SkipsModelValidations:
+  Enabled: false
+
+Metrics/ParameterLists:
+  Max: 12

data/README.md

@@ -0,0 +1,31 @@
+# BoxActiveStorage
+
+TODO: Delete this and the text below, and describe your gem
+
+Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/box_active_storage`. To experiment with that code, run `bin/console` for an interactive prompt.
+
+## Installation
+
+TODO: Replace `UPDATE_WITH_YOUR_GEM_NAME_IMMEDIATELY_AFTER_RELEASE_TO_RUBYGEMS_ORG` with your gem name right after releasing it to RubyGems.org. Please do not do it earlier due to security reasons. Alternatively, replace this section with instructions to install your gem from git if you don't plan to release to RubyGems.org.
+
+Install the gem and add to the application's Gemfile by executing:
+
+    $ bundle add UPDATE_WITH_YOUR_GEM_NAME_IMMEDIATELY_AFTER_RELEASE_TO_RUBYGEMS_ORG
+
+If bundler is not being used to manage dependencies, install the gem by executing:
+
+    $ gem install UPDATE_WITH_YOUR_GEM_NAME_IMMEDIATELY_AFTER_RELEASE_TO_RUBYGEMS_ORG
+
+## 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/[USERNAME]/box_active_storage.

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/box_active_storage.gemspec

@@ -0,0 +1,40 @@
+# frozen_string_literal: true
+
+require_relative "lib/box_active_storage/version"
+
+Gem::Specification.new do |spec|
+  spec.name = "box_active_storage"
+  spec.version = BoxActiveStorage::VERSION
+  spec.authors = ["JoelGamer"]
+  spec.email = ["gtheodoro@rescocompany.com"]
+
+  spec.summary = "This Gem is for integrating Box.com with ActiveStorage."
+  # spec.description = "TODO: Write a longer description or delete this line."
+  spec.homepage = "https://github.com/RESCO-Company/box_active_storage"
+  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/RESCO-Company/box_active_storage"
+  # spec.metadata["changelog_uri"] = "TODO: Put your gem's CHANGELOG.md URL here."
+
+  # 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 "httparty", '~> 0.22'
+
+  # For more information and examples about making a new gem, check out our
+  # guide at: https://bundler.io/guides/creating_gem.html
+end

data/lib/active_storage/service/box_service.rb

@@ -0,0 +1,33 @@
+module ActiveStorage
+  class Service::BoxService < Service
+    def initialize(folder:, client_id:, client_secret:, grant_type:, box_subject_type:, box_subject_id:)
+      @multipart_upload_threshold = 50.megabytes
+
+      @folder = folder
+      @client_id = client_id
+      @client_secret = client_secret
+      @grant_type = grant_type
+      @box_subject_type = box_subject_type
+      @box_subject_id = box_subject_id
+    end
+
+    def upload(key, io, checksum: nil, filename: nil, content_type: nil, disposition: nil, custom_metadata: {}, **)
+      token = BoxActiveStorage::Token.token(client_id: @client_id, client_secret: @client_secret, grant_type: @grant_type, box_subject_type: @box_subject_type, box_subject_id: @box_subject_id)
+
+      instrument :upload, key: key, checksum: checksum, filename: filename do
+        response = BoxActiveStorage::File.upload(token: token, folder: @folder, io: io, filename: filename&.sanitized || File.basename(io))
+        ActiveStorage::Blob.find_by(key: key).update!(key: response['entries'][0]['id'])
+
+        response
+      end
+    end
+
+    def download(key, &block)
+      token = BoxActiveStorage::Token.token(client_id: @client_id, client_secret: @client_secret, grant_type: @grant_type, box_subject_type: @box_subject_type, box_subject_id: @box_subject_id)
+
+      instrument :download, key: key do
+        BoxActiveStorage::File.download(token: token, id: key)
+      end
+    end
+  end
+end

data/lib/box_active_storage/file.rb

@@ -0,0 +1,44 @@
+module BoxActiveStorage
+  class File
+    class NotReadyError < StandardError; end
+    class ClientError < StandardError; end
+    class NotFoundError < StandardError; end
+    class DiskSpaceFullError < StandardError; end
+
+    def download(token:, id:)
+      response = ::HTTParty.get("https://api.box.com/2.0/files/#{id}/content",
+        headers: { 'Authorization': token },
+      )
+
+      if response.code != 200
+        raise NotReadyError.new(response.body) if response.code == 202
+        raise StandardError.new(response.body)
+      end
+
+      response.body.force_encoding(Encoding::BINARY)
+    end
+
+    def upload(token:, folder:, io:, filename:)
+      response = ::HTTParty.post('https://upload.box.com/api/2.0/files/content',
+        multipart: true,
+        headers: { 'Authorization': token },
+        body: {
+          attributes: JSON.generate({ name: filename, parent: { id: folder } }),
+          file: io
+        }
+      )
+
+      if response.code != 201
+        raise ClientError.new(response.body) if response.code == 400
+        raise NotFoundError.new(response.body) if response.code == 404
+        raise DiskSpaceFullError.new(response.body) if response.code == 409
+        raise StandardError.new(response.body)
+      end
+
+      JSON.parse!(response.body)
+    end
+
+    def self.download(...) = new.download(...)
+    def self.upload(...) = new.upload(...)
+  end
+end

data/lib/box_active_storage/folder.rb

@@ -0,0 +1,68 @@
+class BoxActiveStorage::Folder
+  class ClientError < StandardError; end
+  class UnauthorizedError < StandardError; end
+  class NotFoundError < StandardError; end
+  class UnrecognizedError < StandardError; end
+  class BlockedError < StandardError; end
+
+  def information(id:)
+    response = ::HTTParty.get("https://api.box.com/2.0/folders/#{id}",
+      headers: { 'Authorization': @token },
+    )
+
+    if response.code != 200
+      raise UnauthorizedError.new(response.body) if response.code == 403
+      raise NotFoundError.new(response.body) if response.code == 404
+      raise UnrecognizedError.new(response.body) if response.code == 405
+      raise StandardError.new(response.body)
+    end
+
+    JSON.parse!(response.body)
+  end
+
+  def create(name:, parent: '0')
+    response = ::HTTParty.post("https://api.box.com/2.0/folders",
+      headers: { 'Authorization': @token },
+      body: {
+        name: name,
+        parent: { id: parent }
+      }
+    )
+
+    if response.code != 201
+      raise ClientError.new(response.body) if response.code == 400
+      raise UnauthorizedError.new(response.body) if response.code == 403
+      raise NotFoundError.new(response.body) if response.code == 404
+      raise BlockedError.new(response.body) if response.code == 409
+      raise StandardError.new(response.body)
+    end
+
+    JSON.parse!(response.body)
+  end
+
+  def update(id:, name: nil, parent: nil)
+    body = {}
+
+    body = body.merge({ name: name }) if name.present?
+    body = body.merge({ attributes: JSON.generate({ parent: { id: parent } }) }) if parent.present?
+
+    response = ::HTTParty.put("https://api.box.com/2.0/folders",
+      headers: { 'Authorization': @token },
+      body: body
+    )
+
+    if response.code != 201
+      raise ClientError.new(response.body) if response.code == 400
+      raise UnauthorizedError.new(response.body) if response.code == 403
+      raise NotFoundError.new(response.body) if response.code == 404
+      raise BlockedError.new(response.body) if response.code == 409
+      raise StandardError.new(response.body)
+    end
+
+    JSON.parse!(response.body)
+  end
+
+  def self.information(...) = new.information(...)
+  def self.create(...) = new.create(...)
+  def self.update(...) = new.update(...)
+end

data/lib/box_active_storage/token.rb

@@ -0,0 +1,40 @@
+module BoxActiveStorage::Token
+  def self.token(client_id:, client_secret:, grant_type:, box_subject_type:, box_subject_id:)
+    @client_id = client_id
+    @client_secret = client_secret
+    @grant_type = grant_type
+    @box_subject_type = box_subject_type
+    @box_subject_id = box_subject_id
+
+    self.reauth_token
+    @token
+  end
+
+  private
+
+  def self.oauth_token
+    response = ::HTTParty.post('https://api.box.com/oauth2/token',
+      headers: { 'Content-Type' => 'application/x-www-form-urlencoded' },
+      body: URI.encode_www_form({
+        client_id: @client_id,
+        client_secret: @client_secret,
+        grant_type: @grant_type,
+        box_subject_type: @box_subject_type,
+        box_subject_id: @box_subject_id
+      })
+    )
+
+    raise StandardError(response) unless response.code == 200
+
+    parsed_response = JSON.parse!(response.body)
+    refresh_in = Time.now + parsed_response['expires_in'].seconds
+
+    ["Bearer #{parsed_response['access_token']}", refresh_in]
+  end
+
+  def self.reauth_token
+    @token, @refresh_in = oauth_token if @refresh_in.blank? || @refresh_in < Time.now
+  end
+
+  attr_reader :token, :refresh_in
+end

data/lib/box_active_storage/version.rb

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

data/lib/box_active_storage.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+require_relative "box_active_storage/file"
+require_relative "box_active_storage/folder"
+require_relative "box_active_storage/token"
+require_relative "box_active_storage/version"
+
+module BoxActiveStorage
+end

data/sig/box_active_storage.rbs

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

metadata

@@ -0,0 +1,71 @@
+--- !ruby/object:Gem::Specification
+name: box_active_storage
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- JoelGamer
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2024-06-30 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: httparty
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.22'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.22'
+description:
+email:
+- gtheodoro@rescocompany.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".rspec"
+- ".rubocop.yml"
+- README.md
+- Rakefile
+- box_active_storage.gemspec
+- lib/active_storage/service/box_service.rb
+- lib/box_active_storage.rb
+- lib/box_active_storage/file.rb
+- lib/box_active_storage/folder.rb
+- lib/box_active_storage/token.rb
+- lib/box_active_storage/version.rb
+- sig/box_active_storage.rbs
+homepage: https://github.com/RESCO-Company/box_active_storage
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/RESCO-Company/box_active_storage
+  source_code_uri: https://github.com/RESCO-Company/box_active_storage
+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: This Gem is for integrating Box.com with ActiveStorage.
+test_files: []