hudu 0.2.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9f48ff08cda4008e20930d883e35caec1e4558ba6ca5a66bb3b0caae36565679
-  data.tar.gz: 060e661b7be43f050cf6511728cfadb4a892e582fd56d3ecb588dd89a64e9bf8
+  metadata.gz: 6de79a28de35dea4c3ac9ebd26823427f839192e44113fe67f9d5f5e845cade1
+  data.tar.gz: 1bada2b529ac16cc376b85f33b953a451a23f8e955dcc2068814171bcbf0509c
 SHA512:
-  metadata.gz: 85010f142ca7b9b2427ca6d654365c949ca4a36de7373029989343cdcb3b83af2668db2500232cd6cca5a95cd2bf52b6092ce203feb1a81595d404fc292cb188
-  data.tar.gz: 38323855457d5c411143aa1526d839f007428838e039712dfd76fae9bc23ac06f05f7c249506cd716abc369f55d8d6e40d026aa11355a6d83d4c5027f58ff91c
+  metadata.gz: 59adb93ef27db882adc800a183ffbe1b7297e96a11014492ff61774395d0969a79603bd442c452f028fae38fc2b6a9ac591f66151276b94bc4d9b154bddda8f6
+  data.tar.gz: bdf2dfd500420081eb4b530f3621f90ae21f3204e0c817e7e33da8c1baae660425e2c844059693c5f5048d7ee1d16e26159987a7ff1d6562dbc716453e06ea97

data/lib/hudu/api.rb

@@ -1,6 +1,7 @@
 require "wrapi"
 require File.expand_path('authentication', __dir__)
 require File.expand_path('configuration', __dir__)
+require File.expand_path('connection', __dir__)
 
 module Hudu
   # @private
@@ -27,6 +28,7 @@ module Hudu
 
     include Configuration
     include WrAPI::Connection
+    include Connection
     include WrAPI::Request
     include WrAPI::Authentication
     include Authentication

data/lib/hudu/asset_helper.rb

@@ -11,6 +11,18 @@ module Hudu
       custom_asset['custom_fields'] = self.custom_fields(asset.fields)
       { asset: custom_asset }
     end
+
+    # create new asset from layout
+    def self.create_asset name, asset_layout_id, fields
+      custom_asset = { 
+        asset: {
+          name: name,
+          asset_layout_id: asset_layout_id,
+          custom_fields: self.custom_fields(fields)
+        }
+      }
+    end
+  
   private
     def self.custom_fields(fields)
       [fields.map{|field| [field.label.downcase.gsub(' ','_'),field.value]}.to_h]

data/lib/hudu/client.rb

@@ -29,6 +29,11 @@ module Hudu
       end
       # update
       self.send(:define_method, "update_#{method}") do |id=nil,params = {}|
+        r = put(api_url("#{path}/#{id}"), params)
+        r = hudu_data(r,method)
+      end
+      # create
+      self.send(:define_method, "create_#{method}") do |id=nil,params = {}|
         r = post(api_url("#{path}/#{id}"), params)
         r = hudu_data(r,method)
       end
@@ -54,7 +59,7 @@ module Hudu
     api_endpoint :expirations
     api_endpoint :websites, :website
     api_endpoint :relations
-    api_endpoint :magic_dash
+    api_endpoint :magic_dashes, :magic_dash, 'magic_dash'
 
     def company_articles( company_id, params = {} )
       articles({company_id: company_id}.merge(params))
@@ -62,12 +67,16 @@ module Hudu
     def company_assets(id,params={})
       get_paged(api_url("companies/#{id}/assets"), params)
     end
-    def company_asset(id,asset_id,params={})
-      get(api_url("companies/#{id}/assets/#{asset_id}"), params)
+    def company_asset(company_id,asset_id,params={})
+      get(api_url("companies/#{company_id}/assets/#{asset_id}"), params)
     end
 
     def update_company_asset(asset)
-      put(api_url("companies/#{asset.company_id}/assets/#{asset.id}"), AssetHelper.construct_asset(asset))
+      hudu_data(put(api_url("companies/#{asset.company_id}/assets/#{asset.id}"), AssetHelper.construct_asset(asset),false),:asset)
+    end
+
+    def create_company_asset(company_id,asset_layout, fields)
+      hudu_data(post(api_url("companies/#{company_id}/assets"), AssetHelper.create_asset(asset_layout.name,asset_layout.id,fields),false),:asset)
     end
 
     # return api path
@@ -77,8 +86,8 @@ module Hudu
 
     # hudu returns data as {resource:{}} or {resource:[]} 
     def hudu_data(result,resource)
-      if result.is_a?(Hash) && result[resource.to_s]
-        result[resource.to_s]
+      if result.is_a?(WrAPI::Request::Entity) && result.attributes[resource.to_s]
+        result.send resource.to_s
       else
         result
       end

data/lib/hudu/connection.rb

@@ -0,0 +1,20 @@
+require File.expand_path('rate_throttle_middleware', __dir__)
+
+module Hudu
+  # Create connection including authorization parameters with default Accept format and User-Agent
+  # By default
+  # - Bearer authorization is access_token is not nil override with @setup_authorization
+  # - Headers setup for client-id and client-secret when client_id and client_secret are not nil @setup_headers
+  # @private
+  module Connection
+    private
+
+    def connection
+      unless @connection
+        @connection = super
+        @connection.use RateThrottleMiddleware, limit: 250, period: 60
+      end
+      @connection
+    end
+  end
+end

data/lib/hudu/pagination.rb

@@ -15,7 +15,7 @@ module Hudu
       end
 
       def page_options
-        { page: @page }
+        { page: @page, page_size: @page_size }
       end
 
       def next_page!(body)
@@ -31,12 +31,14 @@ module Hudu
 
       def self.data(body) 
         # assume hash {"resource":[...]}, get first key and return array data
-        k,v = body.first
-        if v.is_a?(Array) || v.is_a?(Hash)
-          v
-        else
-          body
+        result = body 
+        if result && result.respond_to?(:first)
+          k,v = body.first
+          if v.is_a?(Array) || v.is_a?(Hash)
+            result = v
+          end
         end
+        result
       end
     end
   end

data/lib/hudu/rate_throttle_middleware.rb

@@ -0,0 +1,67 @@
+require 'faraday'
+require 'thread'
+
+# A Faraday middleware for rate limiting requests.
+#
+# This middleware ensures that the number of requests made through a Faraday connection
+# does not exceed a specified limit within a given time period.
+#
+# @example Add middleware to a Faraday connection
+#   connection = Faraday.new(url: 'https://api.example.com') do |faraday|
+#     faraday.use RateThrottleMiddleware, limit: 300, period: 60
+#     faraday.adapter Faraday.default_adapter
+#   end
+#
+# @see https://github.com/lostisland/faraday Faraday Documentation
+#
+class RateThrottleMiddleware < Faraday::Middleware
+  # Initializes the RateThrottleMiddleware.
+  #
+  # @param app [#call] The next middleware or the actual Faraday adapter.
+  # @param limit [Integer] The maximum number of requests allowed within the specified period. Default is 300.
+  # @param period [Integer] The time period in seconds over which the limit applies. Default is 60 seconds.
+  #
+  # @example
+  #   middleware = RateThrottleMiddleware.new(app, limit: 300, period: 60)
+  #
+  def initialize(app, limit: 300, period: 60)
+    super(app)
+    @limit = limit
+    @period = period
+    @requests = []
+    @mutex = Mutex.new
+    @condition = ConditionVariable.new
+  end
+
+  def call(env)
+    throttle_request
+    @app.call(env)
+  end
+
+private
+
+  def throttle_request
+    @mutex.synchronize do
+      now = Time.now.to_f
+      # Clear requests older than the rate limit period
+      while !@requests.empty? && @requests[0] < (now - @period)
+        @requests.pop
+      end
+
+      # Wait if the request limit is reached
+      while @requests.size >= @limit
+        sleep_time = @requests[0] + @period - now
+puts "<#{sleep_time}>"
+        @condition.wait(@mutex, sleep_time) if sleep_time > 0
+        now = Time.now.to_f
+        while !@requests.empty? && @requests[0] < (now - @period)
+          @requests.pop
+        end
+      end
+
+      # Record the new request
+      @requests.push(Time.now.to_f)
+      @condition.broadcast
+    end
+  end
+end

data/lib/hudu/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Hudu
-  VERSION = '0.2.0'
+  VERSION = '0.3.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: hudu
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors:
 - Janco Tanis
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-03-13 00:00:00.000000000 Z
+date: 2024-11-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -114,8 +114,10 @@ files:
 - lib/hudu/authentication.rb
 - lib/hudu/client.rb
 - lib/hudu/configuration.rb
+- lib/hudu/connection.rb
 - lib/hudu/error.rb
 - lib/hudu/pagination.rb
+- lib/hudu/rate_throttle_middleware.rb
 - lib/hudu/version.rb
 homepage: https://rubygems.org/gems/hudu
 licenses:
@@ -138,7 +140,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.3
+rubygems_version: 3.1.6
 signing_key:
 specification_version: 4
 summary: A Ruby wrapper for the Hudu APIs (readonly)