stac 0.1.0 → 0.3.0

data/sig/stac/file_writer.rbs

@@ -0,0 +1,13 @@
+module STAC
+  class FileWriter
+    @hash_to_json: ^(Hash[String, untyped]) -> String
+
+    def initialize: (?hash_to_json: ^(Hash[String, untyped]) -> String) -> void
+
+    def write: (Hash[String, untyped], dest: String) -> void
+  end
+
+  interface _Writer
+    def write: (Hash[String, untyped], dest: String) -> void
+  end
+end

data/sig/stac/hash_like.rbs

@@ -0,0 +1,13 @@
+module STAC
+  module HashLike
+    attr_reader extra: Hash[String, untyped]
+
+    def []: (String | Symbol key) -> untyped
+    def []=: (String | Symbol key, untyped value) -> untyped
+    def update: (**untyped) -> self
+    def to_hash: -> Hash[String, untyped]
+    def to_h: -> Hash[String, untyped]
+    def to_json: -> String
+    def deep_dup: -> self
+  end
+end

data/sig/stac/item.rbs

@@ -1,27 +1,37 @@
 module STAC
   class Item < STACObject
-    def self.from_hash: (Hash[String, untyped] hash) -> Item
+    def self.from_hash: (Hash[String | Symbol, untyped] hash) -> Item
 
+    attr_accessor id: String
     attr_accessor geometry: Hash[String, untyped]?
-    attr_accessor properties: Properties
-    attr_accessor assets: Hash[String, Asset]
     attr_accessor bbox: Array[Numeric]?
     attr_accessor collection_id: String?
 
+    attr_reader properties: Properties
+    attr_reader assets: Hash[String, Asset]
+
     def initialize: (
       id: String,
       geometry: Hash[String, untyped]?,
       properties: Properties,
-      links: Array[Link],
-      assets: Hash[String, Asset],
+      ?links: Array[Hash[String, String]],
+      ?assets: Hash[String, Asset],
       ?bbox: Array[Numeric]?,
       ?collection: String | Collection | nil,
-      ?stac_extensions: Array[String]?,
+      ?stac_extensions: Array[String],
       **untyped
     ) -> void
 
-    def datetime: -> Time?
     def collection: -> Collection?
     def collection=: (Collection collection) -> void
+    def add_asset: (
+      key: String,
+      href: String,
+      ?title: String?,
+      ?description: String?,
+      ?type: String?,
+      ?roles: Array[String]?,
+      **untyped
+    ) -> self
   end
 end

data/sig/stac/link.rbs

@@ -1,24 +1,33 @@
 module STAC
+  class LinkHrefError < Error
+    attr_reader link: Link
+
+    def initialize: (?String? msg, link: Link) -> void
+  end
+
   class Link
+    include HashLike
+
     def self.from_hash: (Hash[String, untyped]) -> Link
 
     attr_accessor rel: String
-    attr_accessor href: String
+    attr_writer href: String?
     attr_accessor type: String?
     attr_accessor title: String?
-    attr_accessor extra: Hash[String, untyped]
-    attr_accessor owner: STACObject | nil
-    @target: Catalog | Collection | Item | nil
+    attr_accessor owner: STACObject?
+    attr_accessor http_client: _HTTPClient
+    @target: STACObject?
     @resolver: ObjectResolver
 
-    def initialize: (rel: String, href: String, ?type: String?, ?title: String?, **untyped) -> void
-
-    def to_h: -> Hash[String, untyped]
+    def initialize: (?STACObject? target, rel: String, href: String?, ?type: String?, ?title: String?, **untyped) -> void
+    def resolved?: -> bool
+    def href: -> String?
     def absolute_href: -> String?
-    def target: -> (Catalog | Collection | Item | nil)
-
-    private
-
-    def resolver: -> ObjectResolver
+    def relative_href: -> String?
+    def target: (?http_client: _HTTPClient) -> STACObject?
+    
+    def href!: -> String
+    def absolute_href!: -> String
+    def relative_href!: -> String
   end
 end

data/sig/stac/object_resolver.rbs

@@ -2,27 +2,23 @@ module STAC
   class ObjectResolver
     RESOLVABLES: Array[_STACObjectClass]
 
-    attr_writer self.default_http_client: _HTTPClient
+    attr_reader self.resolvables: Array[_STACObjectClass]
 
     def self.default_http_client: -> _HTTPClient
 
     attr_reader http_client: _HTTPClient
 
-    def initialize: (?http_client: _HTTPClient) -> void
+    def initialize: (http_client: _HTTPClient) -> void
 
     def resolve: (String url) -> (Catalog | Collection | Item)
 
     private
 
-    def read: (String url) -> String
+    def read: (String url) -> Hash[String, untyped]
   end
 
   interface _STACObjectClass
-    def type: -> String
-    def from_hash: (Hash[String, untyped] hash) -> (Catalog | Collection | Item)
-  end
-
-  interface _HTTPClient
-    def get: (URI uri) -> String
+    def type: -> String?
+    def from_hash: (Hash[String, untyped] hash) -> untyped
   end
 end

data/sig/stac/properties.rbs

@@ -1,12 +1,12 @@
 module STAC
   class Properties
+    include HashLike
+    include CommonMetadata
+
     def self.from_hash: (Hash[String, untyped] hash) -> Properties
 
     attr_accessor datetime: Time?
-    attr_accessor extra: Hash[String, untyped]
 
     def initialize: (datetime: Time?, **untyped) -> void
-
-    def to_h: -> Hash[String, untyped]
   end
 end

data/sig/stac/provider.rbs

@@ -1,15 +1,14 @@
 module STAC
   class Provider
+    include HashLike
+
     def self.from_hash: (Hash[String, untyped] hash) -> Provider
 
     attr_accessor name: String
     attr_accessor description: String?
     attr_accessor roles: Array[String]?
     attr_accessor url: String?
-    attr_accessor extra: Hash[String, untyped]
 
     def initialize: (name: String, ?description: String?, ?roles: Array[String]?, ?url: String?, **untyped) -> void
-
-    def to_h: -> Hash[String, untyped]
   end
 end

data/sig/stac/{default_http_client.rbs → simple_http_client.rbs}

@@ -1,9 +1,12 @@
 module STAC
-  class DefaultHTTPClient
+  class HTTPError < Error
+  end
+  
+  class SimpleHTTPClient
     attr_reader options: Hash[String, String]
 
     def initialize: (?Hash[String, String] options) -> void
 
-    def get: (URI uri) -> String
+    def get: (URI::Generic | String url) -> Hash[String, untyped]
   end
 end

data/sig/stac/stac_object.rbs

@@ -1,28 +1,51 @@
 module STAC
+  class NoSelfHrefError < Error
+    attr_reader stac_object: STACObject
+
+    def initialize: (?String? msg, stac_object: STACObject) -> void
+  end
+
   class STACObject
-    attr_accessor self.type: String
+    include HashLike
+
+    @@extendables: Hash[String, Extension]
     
-    def self.from_hash: (Hash[String, untyped]) -> STACObject
+    attr_reader self.type: String?
     
-    attr_accessor id: String
-    attr_accessor stac_extensions: Array[String]?
-    attr_accessor extra: Hash[String, untyped]
+    def self.extendables: -> Array[Extension]
+    def self.add_extendable: (Extension) -> self
+    def self.from_hash: (Hash[String | Symbol, untyped]) -> STACObject
+    
+    attr_accessor http_client: _HTTPClient
+    attr_reader stac_extensions: Array[String]
     attr_reader links: Array[Link]
 
+    @extended: Array[Extension]
+
     def initialize: (
-      id: String, links: Array[Link], ?stac_extensions: Array[String]?, **untyped
+      ?links: Array[Hash[String, String]], ?stac_extensions: Array[String], **untyped
     ) -> void
 
     def type: -> String
-    def to_h: -> Hash[String, untyped]
-    def to_json: -> String
-    def add_link: (Link) -> Array[Link]
+    def extended: -> Array[Extension]
+    def add_extension: (Extension | String) -> self
+    def find_link: (rel: String, ?type: String?) -> Link?
+    def add_link: (?STACObject? target, rel: String, ?href: String?, ?type: String?, ?title: String?, **untyped) -> self
     def self_href: -> String?
     def self_href=: (String) -> void
+    def root: -> Catalog?
+    def root=: (Catalog? catalog) -> void
+    def parent: -> Catalog?
+    def parent=: (Catalog? catalog) -> void
+    def save: (?String? dest, ?writer: _Writer) -> void
+
+    def self_href!: -> String
 
     private
 
-    def find_link: (rel: String) -> Link?
-    def remove_link: (rel: String) -> Array[Link]?
+    def extensions: -> Array[Extension]
+    def apply_extensions!: -> void
+    def apply_extension!: (Module) -> void
+    def remove_links: (rel: String) -> Array[Link]?
   end
 end

data/sig/stac.rbs

@@ -1,5 +1,11 @@
 # See the writing guide of rbs: https://github.com/ruby/rbs#guides
 module STAC
+  attr_accessor self.default_http_client: _HTTPClient
+
   def self.from_file: (String path) -> (Catalog | Collection | Item)
-  %a{rbs:test:skip} def self.from_url: (String url, ?resolver: ObjectResolver) -> (Catalog | Collection | Item)
+  def self.from_url: (String url, ?http_client: _HTTPClient) -> (Catalog | Collection | Item)
+
+  interface _HTTPClient
+    def get: (URI::Generic | String url) -> Hash[String, untyped]
+  end
 end

data/stac.gemspec

@@ -26,7 +26,7 @@ Gem::Specification.new do |spec|
   spec.files = Dir.chdir(__dir__) do
     `git ls-files -z`.split("\x0").reject do |f|
       (f == __FILE__) || f.match(
-        %r{\A(?:(?:bin|spec|examples)/|\.(?:git|vscode|devcontainer)|stac-spec)},
+        %r{\A(?:(?:bin|spec)/|\.(?:git|vscode|devcontainer)|stac-spec)},
       )
     end
   end

metadata

@@ -1,16 +1,16 @@
 --- !ruby/object:Gem::Specification
 name: stac
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.3.0
 platform: ruby
 authors:
 - Takahiro Miyoshi
-autorequire: 
+autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-10-09 00:00:00.000000000 Z
+date: 2022-12-16 00:00:00.000000000 Z
 dependencies: []
-description: 
+description:
 email:
 - takahiro-miyoshi@sankichi.net
 executables: []
@@ -21,6 +21,7 @@ files:
 - ".rubocop.yml"
 - CHANGELOG.md
 - CODE_OF_CONDUCT.md
+- GETTING_STARTED.md
 - Gemfile
 - Gemfile.lock
 - LICENSE.txt
@@ -31,14 +32,22 @@ files:
 - lib/stac/asset.rb
 - lib/stac/catalog.rb
 - lib/stac/collection.rb
-- lib/stac/default_http_client.rb
+- lib/stac/common_metadata.rb
 - lib/stac/errors.rb
+- lib/stac/extension.rb
+- lib/stac/extensions/electro_optical.rb
+- lib/stac/extensions/projection.rb
+- lib/stac/extensions/scientific_citation.rb
+- lib/stac/extensions/view_geometry.rb
 - lib/stac/extent.rb
+- lib/stac/file_writer.rb
+- lib/stac/hash_like.rb
 - lib/stac/item.rb
 - lib/stac/link.rb
 - lib/stac/object_resolver.rb
 - lib/stac/properties.rb
 - lib/stac/provider.rb
+- lib/stac/simple_http_client.rb
 - lib/stac/spec_version.rb
 - lib/stac/stac_object.rb
 - lib/stac/version.rb
@@ -47,14 +56,22 @@ files:
 - sig/stac/asset.rbs
 - sig/stac/catalog.rbs
 - sig/stac/collection.rbs
-- sig/stac/default_http_client.rbs
+- sig/stac/common_metadata.rbs
 - sig/stac/errors.rbs
+- sig/stac/extension.rbs
+- sig/stac/extensions/electro_optical.rbs
+- sig/stac/extensions/projection.rbs
+- sig/stac/extensions/scientific_citation.rbs
+- sig/stac/extensions/view_geometry.rbs
 - sig/stac/extent.rbs
+- sig/stac/file_writer.rbs
+- sig/stac/hash_like.rbs
 - sig/stac/item.rbs
 - sig/stac/link.rbs
 - sig/stac/object_resolver.rbs
 - sig/stac/properties.rbs
 - sig/stac/provider.rbs
+- sig/stac/simple_http_client.rbs
 - sig/stac/spec_version.rbs
 - sig/stac/stac_object.rbs
 - sig/stac/version.rbs
@@ -69,7 +86,7 @@ metadata:
   documentation_uri: https://sankichi92.github.io/stac-ruby/
   github_repo: https://github.com/sankichi92/stac-ruby.git
   rubygems_mfa_required: 'true'
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -84,8 +101,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.7
-signing_key: 
+rubygems_version: 3.3.26
+signing_key:
 specification_version: 4
 summary: A library for working with SpatioTemporal Asset Catalog (STAC)
 test_files: []