iucnredlistrb 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: fb22af6fae82248687bf68b0eed02e3ce9d27d3b80c60b39064ce53383073e28
+  data.tar.gz: 1f85da64df8bed2d75956a41210cc4c6158f5376d7aee1ac32ece6e322cae46b
+SHA512:
+  metadata.gz: b6a45115af90ed96441980cae1914f2e0ef3f1d151aada193745616de3c120ab24fab9728e6a9d5f90f2e4f294e107c4aaf8649146fce45cdaaa3fe6619c865e
+  data.tar.gz: 9659b4cd980bbb56bd07a271417f403cedb3ff75d62898e3f9b0d0e3011cba28015db39c031946b51a1c24241931354d84d51c4c80bb269507bff057424daeb6

data/lib/iucnredlistrb/assessment.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module IUCNRedListRb
+  class Assessment
+    def initialize(client)
+      @client = client
+    end
+
+    def find(id)
+      @client.get("assessment/#{id}")
+    end
+  end
+end

data/lib/iucnredlistrb/client.rb

@@ -0,0 +1,66 @@
+# frozen_string_literal: true
+
+module IUCNRedListRb
+  class Client
+    API_BASE = "https://api.iucnredlist.org/api/v4/"
+
+    RESOURCE_NAMES = %w[
+      biogeographical_realms
+      comprehensive_groups
+      conservation_actions
+      countries
+      faos
+      growth_forms
+      habitats
+      population_trends
+      red_list_categories
+      research
+      scopes
+      stresses
+      systems
+      threats
+      use_and_trade
+    ].freeze
+
+    def initialize(api_key:)
+      @connection = initialize_connection_with(api_key: api_key)
+    end
+
+    def assessment
+      @assessment ||= IUCNRedListRb::Assessment.new(self)
+    end
+
+    RESOURCE_NAMES.each do |resource_name|
+      define_method(resource_name) do
+        instance_variable_get("@#{resource_name}") ||
+          instance_variable_set(
+            "@#{resource_name}", IUCNRedListRb::Resource.new(self, resource_name)
+          )
+      end
+    end
+
+    def get(endpoint, query = {})
+      response = @connection.get(endpoint, query)
+
+      if response.success?
+        selected_headers = response.headers.select do |key, _|
+          %w[total-count total-pages current-page page-items].include?(key)
+        end
+
+        response.body.merge(selected_headers)
+      else
+        "Error! Status: #{response.status} #{response.body}"
+      end
+    end
+
+    private
+
+    def initialize_connection_with(api_key:)
+      Faraday.new(url: API_BASE) do |connection|
+        connection.headers["accept"] = "*/*"
+        connection.headers["Authorization"] = api_key
+        connection.response :json
+      end
+    end
+  end
+end

data/lib/iucnredlistrb/resource.rb

@@ -0,0 +1,46 @@
+# frozen_string_literal: true
+
+module IUCNRedListRb
+  class Resource
+    def initialize(client, endpoint)
+      @client = client
+      @endpoint = endpoint
+    end
+
+    def list
+      @client.get(@endpoint)
+    end
+
+    def find(id, query = {})
+      @client.get("#{@endpoint}/#{id}", query)
+    end
+
+    def all(id, query = {}, show_progress: false, wait_time: 0.5)
+      all_responses = find(id, query)
+      total_pages = all_responses["total-pages"].to_i
+
+      return all_responses if total_pages == 1
+
+      (2..total_pages).each do |page|
+        show_progress_for(page, total_pages) if show_progress
+
+        sleep wait_time
+        paged_response = find(id, query.merge(page: page))
+        all_responses["assessments"] += paged_response["assessments"]
+      end
+
+      all_responses
+    end
+
+    private
+
+    def show_progress_for(page, total_pages)
+      percent = (page / total_pages.to_f) * 100
+      bar_length = 30
+      filled_length = (percent / (100.0 / bar_length)).round
+      bar = "█" * filled_length + "-" * (bar_length - filled_length)
+
+      print "\r[#{bar}] #{percent.round(1).clamp(0..100)}% Complete  "
+    end
+  end
+end

data/lib/iucnredlistrb/version.rb

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

data/lib/iucnredlistrb.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+require "net/http"
+require "faraday"
+require "json"
+
+require_relative "iucnredlistrb/assessment"
+require_relative "iucnredlistrb/client"
+require_relative "iucnredlistrb/resource"
+require_relative "iucnredlistrb/version"
+
+module IUCNRedListRb
+  class Error < StandardError; end
+end

metadata

@@ -0,0 +1,53 @@
+--- !ruby/object:Gem::Specification
+name: iucnredlistrb
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Ian Townsend
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2025-03-28 00:00:00.000000000 Z
+dependencies: []
+description: This gem provides a simple interface to interact with the IUCN Red List
+  API https://api.iucnredlist.org/.
+email:
+- conservation.informatics@iucn.org
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/iucnredlistrb.rb
+- lib/iucnredlistrb/assessment.rb
+- lib/iucnredlistrb/client.rb
+- lib/iucnredlistrb/resource.rb
+- lib/iucnredlistrb/version.rb
+homepage: https://github.com/IUCN-UK/iucnredlistrb
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+  homepage_uri: https://github.com/IUCN-UK/iucnredlistrb
+  source_code_uri: https://github.com/IUCN-UK/iucnredlistrb
+  changelog_uri: https://github.com/IUCN-UK/iucnredlistrb/blob/main/CHANGELOG.md
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 3.0.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.5.16
+signing_key:
+specification_version: 4
+summary: A Ruby Gem that wraps the IUCN Red List API for fetching assessment data.
+test_files: []