open_recycling 0.0.1 → 0.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4353807923307e777bfd3b7f64f2bf76eb47397a7d70b9c32f5ae43e19a345e6
-  data.tar.gz: ca572c16f265cce9eb9f365f4d936b1209fd159ac25ea826143b87852382169f
+  metadata.gz: a44449639927e8adf871ffd260f6f65cff7e353dde55d96ff7b21da3dfef6b7d
+  data.tar.gz: 5bd9bef0572adc15f64129b9fc797cc8224c03af595dc2306c52341e0b8819a4
 SHA512:
-  metadata.gz: 2bbff8d0802a87243494be7f36047f230adc485d8e6a034c75830fc3add85c26e911af30d6994871fa8d4331fc22c616a30342c23094c30e306434d1f8579ff6
-  data.tar.gz: 0f49efc3c727ac4217ec3dd8ddee1cc0b4494a4f55897c8983990f1aad32c806ee49643916c4746f008a6a4160a979a0d19eae2dfdb220d8eb31ebf9d355951c
+  metadata.gz: 21b84535fe05629fcbf50f74183bb43d6824ab870d69a3647aacb8d9a8828eb7c1498ea2355066f7b104a97781cdee81b5469e9f9ec5f5bb99b0c27519792313
+  data.tar.gz: 8e3a7674a29d750c2891a225e339f59028a6a8bb256066665d96e1142e28b81ae4f064538db9da03e32f1c527e1913378e1672492425cc3e24e2c255c5f530d7

data/README.md

@@ -1,31 +1,33 @@
-# OpenRecycling
+# Open Recycling API Client
 
-API client for OpenRecycling API
+Ruby client for the Open Recycling API. You can use this gem to develop applications that interact with the Open Recycling Platform.
 
 ## 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
+    $ bundle add open_recycling
+
+Or add it manually to the Gemfile:
+
+```ruby
+gem 'open_recycling'
+```
 
 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
+    $ gem install open_recycling
 
 ## Usage
 
-Register a new application on OpenRecycling and get the application id, api key and secret key.
-
-Furthermore, you need to have an application user id as the application always acts on behalf of a user.
+Register a new application on the Open Recycling Platform and get the application id, api key and secret key. Furthermore, you need to have an application user id as the application always acts on behalf of a user.
 
 With the above information, you can generate a JWT token using the `OpenRecycling.generate_token` method.
 
 ```
 require 'open_recycling'
 
-OpenRecycling.api_url = "<>"
+OpenRecycling.api_url = "<open recycling url>"
 OpenRecycling.jwt_token = OpenRecycling.generate_token(
   application_id: "<application id>",
   api_key: "<api key>",
@@ -40,26 +42,16 @@ You can now create a new client instance.
 client = OpenRecycling::Client.new
 ```
 
-With the client setup, you can now make requests to the OpenRecycling API.
+With the client setup, you can now make requests to the OpenRecycling API, e.g. to fetch all organizations.
 
 ```ruby
 organizations = client.org.organizations.all
 ```
 
-## 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
-
-Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/open_recycling. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/[USERNAME]/open_recycling/blob/main/CODE_OF_CONDUCT.md).
-
 ## 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 OpenRecycling project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/open_recycling/blob/main/CODE_OF_CONDUCT.md).
+Everyone interacting in the Open Recycling project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/open_recycling/blob/main/CODE_OF_CONDUCT.md).

data/lib/open_recycling/apps/client.rb

@@ -0,0 +1,20 @@
+require_relative "applications"
+
+module OpenRecycling
+  module Apps
+    class Client < OpenRecycling::ModuleClient
+      def applications
+        @applications ||= OpenRecycling::Org::Applications.new(
+          base_url: module_url,
+          jwt_token: jwt_token
+        )
+      end
+
+      private
+
+      def module_url
+        "#{base_url}/apps/v1"
+      end
+    end
+  end
+end

data/lib/open_recycling/client.rb

@@ -1,8 +1,18 @@
+require_relative "apps/client"
 require_relative "org/client"
 require_relative "core/client"
+require_relative "documents/client"
 
 module OpenRecycling
   class Client < OpenRecycling::ModuleClient
+
+    def apps
+      @apps ||= OpenRecycling::Apps::Client.new(
+        base_url: base_url,
+        jwt_token: jwt_token
+      )
+    end
+
     def org
       @org ||= OpenRecycling::Org::Client.new(
         base_url: base_url,
@@ -16,5 +26,12 @@ module OpenRecycling
         jwt_token: jwt_token
       )
     end
+
+    def documents
+      @documents ||= OpenRecycling::Documents::Client.new(
+        base_url: base_url,
+        jwt_token: jwt_token
+      )
+    end
   end
 end

data/lib/open_recycling/documents/client.rb

@@ -0,0 +1,29 @@
+require_relative "uploads"
+require_relative "documents"
+
+module OpenRecycling
+  module Documents
+    class Client < OpenRecycling::ModuleClient
+
+      def documents
+        @documents ||= OpenRecycling::Documents::Documents.new(
+          base_url: module_url,
+          jwt_token: jwt_token
+        )
+      end
+
+      def uploads
+        @uploads ||= OpenRecycling::Documents::Uploads.new(
+          base_url: module_url,
+          jwt_token: jwt_token
+        )
+      end
+
+      private
+
+      def module_url
+        "#{base_url}/documents/v1"
+      end
+    end
+  end
+end

data/lib/open_recycling/documents/documents.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+module OpenRecycling
+  module Documents
+    class Documents < OpenRecycling::Resource
+      only :all, :find
+
+      def initialize(base_url: nil, jwt_token: nil)
+        super(
+          root_node_singular: "document",
+          root_node_plural: "document",
+          api_url: "#{base_url}/document",
+          jwt_token: jwt_token
+        )
+      end
+    end
+  end
+end

data/lib/open_recycling/documents/uploads.rb

@@ -0,0 +1,62 @@
+# frozen_string_literal: true
+
+module OpenRecycling
+  module Documents
+    class Uploads < OpenRecycling::Resource
+      only :create, :all
+
+      def initialize(base_url: nil, jwt_token: nil)
+        super(
+          root_node_singular: "upload",
+          root_node_plural: "uploads",
+          api_url: "#{base_url}/uploads",
+          jwt_token: jwt_token
+        )
+      end
+
+      def create(file_path:, mime_type:, organization_id:)
+        uri = URI(api_url)
+
+        # Prepare the file and boundary
+        boundary = "----Upload#{rand(1000000)}"
+        file = File.open(file_path, 'rb')
+        file_content = file.read
+
+        # Prepare multipart body
+        post_body = []
+        post_body << "--#{boundary}\r\n"
+        post_body << "Content-Disposition: form-data; name=\"upload[file]\"; filename=\"#{File.basename(file_path)}\"\r\n"
+        post_body << "Content-Type: #{mime_type}\r\n\r\n"
+        post_body << file_content
+        post_body << "\r\n"
+
+        # Add the `upload[organizationId]` part
+        post_body << "--#{boundary}\r\n"
+        post_body << "Content-Disposition: form-data; name=\"upload[organizationId]\"\r\n\r\n"
+        post_body << organization_id.to_s
+        post_body << "\r\n"
+
+        post_body << "--#{boundary}--\r\n"
+
+        # Create and send the POST request
+        http = Net::HTTP.new(uri.host, uri.port)
+        http.use_ssl = (uri.scheme == 'https')
+
+        request = Net::HTTP::Post.new(uri.path)
+        request['Content-Type'] = "multipart/form-data; boundary=#{boundary}"
+        request["Authorization"] = "Bearer #{jwt_token}"
+        request["Accept"] = "application/json"
+        request.body = post_body.join
+
+        # Execute the request and get the response
+        response = http.request(request)
+
+        if response.is_a?(Net::HTTPSuccess)
+          parse_resource(response.body)
+        else
+          handle_error(response)
+        end
+      end
+    end
+  end
+end

data/lib/open_recycling/org/client.rb

@@ -1,5 +1,4 @@
 require_relative "organizations"
-require_relative "applications"
 
 module OpenRecycling
   module Org
@@ -11,13 +10,6 @@ module OpenRecycling
         )
       end
 
-      def applications
-        @applications ||= OpenRecycling::Org::Applications.new(
-          base_url: module_url,
-          jwt_token: jwt_token
-        )
-      end
-
       private
 
       def module_url

data/lib/open_recycling/resource.rb

@@ -12,6 +12,8 @@ module OpenRecycling
     end
 
     def all(options = {})
+      ensure_supported_method(:all)
+
       uri = URI(build_uri_with_params(api_url, options))
       response = execute_request(Net::HTTP::Get, uri)
 
@@ -23,6 +25,8 @@ module OpenRecycling
     end
 
     def find(id)
+      ensure_supported_method(:find)
+
       uri = URI("#{api_url}/#{id}")
       response = execute_request(Net::HTTP::Get, uri)
 
@@ -34,6 +38,8 @@ module OpenRecycling
     end
 
     def create(attributes)
+      ensure_supported_method(:create)
+
       uri = URI(api_url)
       response = execute_request(Net::HTTP::Post, uri, { root_node_singular => attributes }.to_json)
 
@@ -45,6 +51,8 @@ module OpenRecycling
     end
 
     def update(id, attributes)
+      ensure_supported_method(:update)
+
       uri = URI("#{api_url}/#{id}")
       response = execute_request(Net::HTTP::Patch, uri, { root_node_singular => attributes }.to_json)
 
@@ -56,6 +64,8 @@ module OpenRecycling
     end
 
     def destroy(id)
+      ensure_supported_method(:destroy)
+
       uri = URI("#{api_url}/#{id}")
       response = execute_request(Net::HTTP::Delete, uri)
 
@@ -66,6 +76,20 @@ module OpenRecycling
       end
     end
 
+    def ensure_supported_method(method)
+      return if self.class.supported_methods.include?(method)
+
+      raise NotImplementedError.new("Method `#{method}` is not supported for this resource")
+    end
+
+    def self.only(*methods)
+      @only = methods
+    end
+
+    def self.supported_methods
+      @only ||= [:all, :find, :create, :update, :destroy]
+    end
+
     private
 
     def execute_request(cls, uri, body = nil)
@@ -88,11 +112,16 @@ module OpenRecycling
     end
 
     def parse_resources(body)
-      parse_body(body)[root_node_plural] || []
+      parsed_response = parse_body(body)
+      {
+        data: parsed_response[root_node_plural.to_sym] || [],
+      }
     end
 
     def parse_resource(body)
-      parse_body(body)[root_node_singular]
+      {
+        data: parse_body(body)[root_node_singular.to_sym],
+      }
     end
 
     def parse_body(body)
@@ -102,7 +131,7 @@ module OpenRecycling
     def underscored(hash_or_array)
       if hash_or_array.is_a?(Hash)
         hash_or_array.reduce({}) do |memo, (k, v)|
-          memo.merge(underscore(k) => underscored(v))
+          memo.merge(underscore(k).to_sym => underscored(v))
         end
       elsif hash_or_array.is_a?(Array)
         hash_or_array.map { |hash| underscored(hash) }

data/lib/open_recycling/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module OpenRecycling
-  VERSION = "0.0.1"
+  VERSION = "0.0.3"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: open_recycling
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.3
 platform: ruby
 authors:
 - Open Recycling
@@ -43,12 +43,16 @@ files:
 - README.md
 - Rakefile
 - lib/open_recycling.rb
+- lib/open_recycling/apps/applications.rb
+- lib/open_recycling/apps/client.rb
 - lib/open_recycling/client.rb
 - lib/open_recycling/client_error.rb
 - lib/open_recycling/core/client.rb
 - lib/open_recycling/core/invoices.rb
+- lib/open_recycling/documents/client.rb
+- lib/open_recycling/documents/documents.rb
+- lib/open_recycling/documents/uploads.rb
 - lib/open_recycling/module_client.rb
-- lib/open_recycling/org/applications.rb
 - lib/open_recycling/org/client.rb
 - lib/open_recycling/org/organizations.rb
 - lib/open_recycling/resource.rb