big_marker_client 0.1.4 → 0.1.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d6fb91b5a5354ae4629ec265e53476357d78dbd65da6996cf24de3c7866a3402
-  data.tar.gz: cadac9e803e07b4836b3a6008a825f976884877196852b9573fbc33c59f35386
+  metadata.gz: 761022b647bdfeecdd833b29b236ff768cf2713d2d5c82a3986638d5cc67b0d5
+  data.tar.gz: 16707b0d879dd593066b400677c343bdfa47eed6d97e5132a5f99599b94e64e6
 SHA512:
-  metadata.gz: 62a7c90fe1839b181dfe1f3103933de22053e7330a9e17044d17c5323a67929bd23bf9c1f81d8741807d56018c1c40c4b9a8765ecc6ed9137bd9ff4496cf5628
-  data.tar.gz: c08e7e125dc6fd43a8174f40d0c52d300431704030436b36f6afe942c379b081b9a1106b9aaf3a9254bd801ad6810a86dce4e12edc2ba5d78dd62ba76021911a
+  metadata.gz: c18cf2836336c335143e01690ccbc3acdfaf96f39bc86d415270fc9e8bf8b97c5069f35d508e664a65dab94bd97cba7d191acada60fd242a710b56828229e948
+  data.tar.gz: 12d4ca8e8394a012f395dbd910c3a9835c9a072b20e88a39167f25adecf1b77d1483cbb42a303f05774b39405fc06bcda4fc806a8056b932003c9533935b36b7

data/.rubocop.yml

@@ -1,5 +1,5 @@
 AllCops:
-  TargetRubyVersion: 3.0
+  TargetRubyVersion: 2.6
   NewCops: enable
   Exclude:
     - "vendor/**/*"
@@ -18,10 +18,6 @@ Metrics/BlockLength:
     - "spec/**/*"
     - "big_marker_client.gemspec"
 
-Performance/StringIdentifierArgument:
-  Exclude:
-    - "lib/big_marker_client/base.rb"
-
 Style/Documentation:
   Enabled: false
 

data/CHANGELOG.md

@@ -1,3 +1,12 @@
+## [0.1.6] - 2022-01-19
+
+- fix recurring method to return "child_conferences"
+
+## [0.1.5] - 2022-01-19 (broken, don't use!)
+
+- refactor HTTP client into a separate class
+- fix looping if no meta-data is returned
+
 ## [0.1.4] - 2022-01-18
 
 - add new properties to attendees and add handout model and factory

data/lib/big_marker_client/api/v1/conference.rb

@@ -116,7 +116,7 @@ module BigMarkerClient
           def recurring(conference_id, params = {})
             result = get(replace_path_params(path: RECURRING_CONFERENCES,
                                              replacements: { "{id}": conference_id }), params)
-            return map_to_model_array(result["conferences"]) if result["conferences"]
+            return map_to_model_array(result["child_conferences"]) if result["child_conferences"]
 
             result
           end
@@ -126,7 +126,7 @@ module BigMarkerClient
           # @see #recurring
           def recurring_all(conference_id, params = {})
             path = replace_path_params(path: RECURRING_CONFERENCES, replacements: { "{id}": conference_id })
-            loop_over(path, "conferences", ::BigMarkerClient::Models::Conference, params)
+            loop_over(path, "child_conferences", ::BigMarkerClient::Models::Conference, params)
           end
 
           ##

data/lib/big_marker_client/base.rb

@@ -3,6 +3,8 @@ require "typhoeus/adapters/faraday"
 
 module BigMarkerClient
   class Base
+    DEFAULT_PER_PAGE_SIZE = 25
+
     class << self
       def post(path, body = {})
         request(verb: :post, path: path, params: body)
@@ -36,10 +38,10 @@ module BigMarkerClient
         page = 1
         results = []
         loop do
-          params[:page] = page
+          params["page"] = page
           result = send(method, path, params)
           results += map_to_model_array(result[field], model_class) if result[field]
-          break if page >= result["total_pages"].to_i || results.length >= total_count(result).to_i
+          break if break?(results: results, result: result, page: page, page_size: page_size(params))
 
           page += 1
         end
@@ -50,55 +52,69 @@ module BigMarkerClient
 
       def request(path:, verb: :get, params: {})
         check_preconditions(verb, path)
+        params = stringify_keys(params)
 
         params = params.to_json unless %w[get delete].include?(verb.to_s)
-        response = http_client.send(verb.to_s, base_url(path), params)
+        @http_client ||= HttpClient.new
+        response = @http_client.connection.send(verb.to_s, base_url(path), params)
         parse_body(response.body)
       end
 
       def check_preconditions(verb, path)
-        if verb.nil? || path.nil? || BigMarkerClient::Config.api_key.nil?
-          raise ArgumentError, "http_method, path or api key is missing"
-        end
+        raise ArgumentError, "http_method, path or api key is missing" if verb.nil? || path.nil? || Config.api_key.nil?
         raise ArgumentError, "unsupported http_method: #{verb}" unless %w[post put patch delete get].include?(verb.to_s)
       end
 
-      def http_client
-        conn ||= Faraday.new(url: BigMarkerClient::Config.base_url) do |faraday|
-          faraday = headers(faraday)
-          configure_logging(faraday) if BigMarkerClient::Config.log
-        end
-        conn.adapter :typhoeus
-        conn
-      end
-
-      def headers(adapter)
-        adapter.headers["Content-Type"] = "application/json"
-        adapter.headers["API-KEY"] = BigMarkerClient::Config.api_key unless BigMarkerClient::Config.api_key.nil?
-        adapter
-      end
-
-      def configure_logging(adapter)
-        adapter.response :logger do |logger|
-          logger.instance_variable_get("@options")[:log_level] = :debug if BigMarkerClient::Config.debug
-          logger.filter(/password=([^&]+)/, "password=[FILTERED]")
-          logger.filter(/API-KEY: "(\w*)"/, "API-KEY: [FILTERED]")
+      def stringify_keys(hash)
+        hash_symbol_keys = hash.keys.select { |key| key.is_a?(Symbol) }
+        hash_symbol_keys.each do |key|
+          hash[key.to_s] = hash[key]
+          hash.delete(key)
         end
-        adapter
+        hash
       end
 
       def base_url(path)
-        BigMarkerClient::Config.base_url + (path.start_with?("/") ? path : "/#{path}")
+        Config.base_url + (path.start_with?("/") ? path : "/#{path}")
       end
 
       def parse_body(body)
         return nil if body.strip == ""
 
         json = JSON.parse(body)
-        BigMarkerClient::Config.logger.debug(json) if BigMarkerClient::Config.debug
+        Config.logger.debug(json) if Config.debug
         json
       rescue JSON::ParserError
-        raise BigMarkerClient::ResponseError, "invalid response"
+        raise ResponseError, "invalid response"
+      end
+
+      def page_size(params)
+        params["page_count"] || params.fetch("per_page", DEFAULT_PER_PAGE_SIZE)
+      end
+
+      ##
+      # BigMarker API is a total mess that won't return total_pages or total_entries on all request types so we have to
+      # get creative
+      def break?(results:, result:, page:, page_size:)
+        return true if break_on_full_metadata?(results: results, result: result, page: page) ||
+                       break_on_partial_metadata?(results: results, result: result, page: page)
+
+        results.length.zero? || (results.length % page_size) != 0 || (results.length.to_f / page_size) < page
+      end
+
+      def break_on_full_metadata?(results:, result:, page:)
+        if !result["total_pages"].nil? && !total_count(result).nil?
+          return ((page >= result["total_pages"].to_i) || (results.length >= total_count(result).to_i))
+        end
+
+        false
+      end
+
+      def break_on_partial_metadata?(results:, result:, page:)
+        return page >= result["total_pages"].to_i unless result["total_pages"].nil?
+        return results.length >= total_count(result).to_i unless total_count(result).nil?
+
+        false
       end
 
       ##

data/lib/big_marker_client/http_client.rb

@@ -0,0 +1,30 @@
+module BigMarkerClient
+  class HttpClient
+    attr_reader :connection
+
+    def initialize
+      @connection = Faraday.new(url: Config.base_url) do |faraday|
+        faraday = headers(faraday)
+        configure_logging(faraday) if Config.log
+      end
+      @connection.adapter :typhoeus
+    end
+
+    private
+
+    def headers(adapter)
+      adapter.headers["Content-Type"] = "application/json"
+      adapter.headers["API-KEY"] = Config.api_key unless Config.api_key.nil?
+      adapter
+    end
+
+    def configure_logging(adapter)
+      adapter.response :logger do |logger|
+        logger.instance_variable_get(:@options)[:log_level] = :debug if Config.debug
+        logger.filter(/password=([^&]+)/, "password=[FILTERED]")
+        logger.filter(/API-KEY: "(\w*)"/, "API-KEY: [FILTERED]")
+      end
+      adapter
+    end
+  end
+end

data/lib/big_marker_client/version.rb

@@ -1,3 +1,3 @@
 module BigMarkerClient
-  VERSION = "0.1.4".freeze
+  VERSION = "0.1.6".freeze
 end

data/lib/big_marker_client.rb

@@ -10,6 +10,7 @@ module BigMarkerClient
 
   autoload :Base, "big_marker_client/base"
   autoload :Config, "big_marker_client/config"
+  autoload :HttpClient, "big_marker_client/http_client"
   autoload :Version, "big_marker_client/version"
 
   module Api

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: big_marker_client
 version: !ruby/object:Gem::Version
-  version: 0.1.4
+  version: 0.1.6
 platform: ruby
 authors:
 - Burkhard Vogel-Kreykenbohm
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-01-18 00:00:00.000000000 Z
+date: 2022-01-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -92,6 +92,7 @@ files:
 - lib/big_marker_client/api/v1/presenter.rb
 - lib/big_marker_client/base.rb
 - lib/big_marker_client/config.rb
+- lib/big_marker_client/http_client.rb
 - lib/big_marker_client/models/attendee.rb
 - lib/big_marker_client/models/base.rb
 - lib/big_marker_client/models/conference.rb
@@ -124,7 +125,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '3.0'
+      version: '2.6'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="