sideko_hacker_news 0.1.1 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ef178a860465610752cc33330438201f920004ba291de4b1096e78fb008195a8
-  data.tar.gz: e4c4c378fd1c24431b2d317f8f939d5a5631ba2c638d2e298e9801e87915784a
+  metadata.gz: bd4caa1413f271609180311354ca586ea6ffe7ec01a70e94de54c14918ea19cf
+  data.tar.gz: 31087653cab1a2db2570ae271278e15a791fd00454cecdad3df2ce9ca3fa8f65
 SHA512:
-  metadata.gz: 6fcf7a3adf6293e26f3ab4390eee3ac944bacc051759278ca77c041cbed515c404517a3067da18960ec30417b6506e92db1a9e7dfae3e34d3dd4be3caeb3b0b5
-  data.tar.gz: ae27e4a6f5fd26bbf2672aaa65c06430c0610cf2d8779e555bd204fd46bb5720a6d7315875724dd5167f0a8e27d94dce92454a5241500460813d5bd78ba8c36e
+  metadata.gz: 30c22b2cfa6cea1f4c3874220b2dc165d802dc97173728e274635f490831bf8bf04a7160a0e66ca664ca343fdbb8f05054ab4c95c37e747a860b143c6ee84e0a
+  data.tar.gz: 141b84970c299dd058348d2a53e246032f03b235e790fff2b41614064fff9b2999a2c0aaa4c2b09d23e47acbb02263690a10e24b0fdbf98ed5e13af71001704f

data/lib/sideko_hacker_news.rb

@@ -2,7 +2,6 @@
 # frozen_string_literal: true
 require 'json'
 require 'http'
-require_relative 'schemas'
 
 class RequestError < StandardError
   attr_reader :status_code, :method, :url, :data
@@ -21,40 +20,149 @@ class RequestError < StandardError
   end
 end
 
+module AuthProvider
+  def add_auth(http_client, req_kwargs)
+    raise NotImplementedError, "You must implement the 'add_auth' method"
+  end
+end
+
+class AuthBasic
+  include AuthProvider
+
+  attr_accessor :username, :password
+
+  def initialize(username: nil, password: nil)
+    @username = username
+    @password = password
+  end
+
+  def add_auth(http_client, req_kwargs)
+    if !@username.nil? && !@password.nil?
+      http_client = http_client.basic_auth(user: @username, pass: @password)
+    end
+
+    return http_client, req_kwargs
+  end
+end
+
+class AuthBearer
+  include AuthProvider
+
+  attr_accessor :val
+
+  def initialize(val: nil)
+    @val = val
+  end
+
+  def add_auth(http_client, req_kwargs)
+    if !@val.nil?
+      headers = req_kwargs.fetch(:headers, {})
+      headers["Authorization"] = "Bearer " + @val
+      req_kwargs[:headers] = headers
+    end
+
+    return http_client, req_kwargs
+  end
+end
+
+class AuthKeyQuery
+  include AuthProvider
+
+  attr_accessor :query_name, :val
+
+  def initialize(query_name: nil, val: nil)
+    @query_name = query_name
+    @val = val
+  end
+
+  def add_auth(http_client, req_kwargs)
+    if !val.nil?
+      params = req_kwargs.fetch(:params, {})
+      params[query_name] = val
+      req_kwargs[:params] = params
+    end
+
+    return http_client, req_kwargs
+  end
+end
+
+class AuthKeyHeader
+  include AuthProvider
+
+  attr_accessor :header_name, :val
+
+  def initialize(header_name: nil, val: nil)
+    @header_name = header_name
+    @val = val
+  end
+
+  def add_auth(http_client, req_kwargs)
+    if !@val.nil?
+      headers = req_kwargs.fetch(:headers, {})
+      headers[@header_name] = @val
+      req_kwargs[:headers] = headers
+    end
+
+    return http_client, req_kwargs
+  end
+end
+
+class AuthKeyCookie
+  include AuthProvider
+
+  attr_accessor :cookie_name, :val
+
+  def initialize(cookie_name: nil, val: nil)
+    @cookie_name = cookie_name
+    @val = val
+  end
+
+  def add_auth(http_client, req_kwargs)
+    if !@val.nil?
+      http_client = http_client.cookies(@cookie_name => @val)
+    end
+
+    return http_client, req_kwargs
+  end
+end
+
 class Client
-  def initialize(base_url='https://hacker-news.firebaseio.com/v0')
-    @_client = HTTP.persistent(nil)
+  def initialize(base_url: 'https://hacker-news.firebaseio.com/v0')
     @_base_url = base_url
+    # register auth providers
+    @_auth = {}
   end
 
-  def _cast_array(input_array, target_class)
-    casted = []
-    input_array.each { |el|
-      if el.class == Array
-        casted.append(_cast_array(el, target_class))
-      else
-        casted.append(target_class.from_json!(JSON.generate(el)))
-      end
-    }
-    casted
+  def _client_with_auth(auth_names, **req_kwargs)
+    http_client = HTTP
+    auth_names.each do |auth_name|
+      provider = @_auth[auth_name]
+      http_client, req_kwargs = provider.add_auth(http_client, req_kwargs) if provider
+    end
+    
+    return http_client, req_kwargs
   end
 
   def get_ask_story_ids(print: nil)
-    url = @_base_url + "/askstories.json"
-    params = {}
+    _url = @_base_url + "/askstories.json"
+    _kwargs = {
+      params: {}
+    }
     if print != nil
-      params[:print] = print
+       _kwargs[:params][:"print"] = print
     end
+    _http_client, _req_kwargs = self._client_with_auth(
+      [],
+      **_kwargs
+    )
 
     
-    response = @_client.get(
-      url,
-      :params => params,
+    response = _http_client.get(
+      _url,
       
+      **_req_kwargs
     )
-    if response.status.success?
-      response = response.parse
-    else
+    if !response.status.success?
       raise RequestError.new(
         status_code=response.status,
         method="get",
@@ -63,25 +171,29 @@ class Client
       )
     end
 
-    response
+    return response.parse
   end
 
   def get_best_story_ids(print: nil)
-    url = @_base_url + "/beststories.json"
-    params = {}
+    _url = @_base_url + "/beststories.json"
+    _kwargs = {
+      params: {}
+    }
     if print != nil
-      params[:print] = print
+       _kwargs[:params][:"print"] = print
     end
+    _http_client, _req_kwargs = self._client_with_auth(
+      [],
+      **_kwargs
+    )
 
     
-    response = @_client.get(
-      url,
-      :params => params,
+    response = _http_client.get(
+      _url,
       
+      **_req_kwargs
     )
-    if response.status.success?
-      response = response.parse
-    else
+    if !response.status.success?
       raise RequestError.new(
         status_code=response.status,
         method="get",
@@ -90,25 +202,29 @@ class Client
       )
     end
 
-    response
+    return response.parse
   end
 
-  def get_item(id:, print: nil)
-    url = @_base_url + "/item/#{id}.json"
-    params = {}
+  def get_item(id, print: nil)
+    _url = @_base_url + "/item/#{id}.json"
+    _kwargs = {
+      params: {}
+    }
     if print != nil
-      params[:print] = print
+       _kwargs[:params][:"print"] = print
     end
+    _http_client, _req_kwargs = self._client_with_auth(
+      [],
+      **_kwargs
+    )
 
     
-    response = @_client.get(
-      url,
-      :params => params,
+    response = _http_client.get(
+      _url,
       
+      **_req_kwargs
     )
-    if response.status.success?
-      response = response.parse
-    else
+    if !response.status.success?
       raise RequestError.new(
         status_code=response.status,
         method="get",
@@ -117,26 +233,29 @@ class Client
       )
     end
 
-    response = Item.from_dynamic!(response)
-    response
+    return response.parse
   end
 
   def get_job_story_ids(print: nil)
-    url = @_base_url + "/jobstories.json"
-    params = {}
+    _url = @_base_url + "/jobstories.json"
+    _kwargs = {
+      params: {}
+    }
     if print != nil
-      params[:print] = print
+       _kwargs[:params][:"print"] = print
     end
+    _http_client, _req_kwargs = self._client_with_auth(
+      [],
+      **_kwargs
+    )
 
     
-    response = @_client.get(
-      url,
-      :params => params,
+    response = _http_client.get(
+      _url,
       
+      **_req_kwargs
     )
-    if response.status.success?
-      response = response.parse
-    else
+    if !response.status.success?
       raise RequestError.new(
         status_code=response.status,
         method="get",
@@ -145,25 +264,29 @@ class Client
       )
     end
 
-    response
+    return response.parse
   end
 
   def get_max_item_id(print: nil)
-    url = @_base_url + "/maxitem.json"
-    params = {}
+    _url = @_base_url + "/maxitem.json"
+    _kwargs = {
+      params: {}
+    }
     if print != nil
-      params[:print] = print
+       _kwargs[:params][:"print"] = print
     end
+    _http_client, _req_kwargs = self._client_with_auth(
+      [],
+      **_kwargs
+    )
 
     
-    response = @_client.get(
-      url,
-      :params => params,
+    response = _http_client.get(
+      _url,
       
+      **_req_kwargs
     )
-    if response.status.success?
-      response = response.parse
-    else
+    if !response.status.success?
       raise RequestError.new(
         status_code=response.status,
         method="get",
@@ -172,25 +295,29 @@ class Client
       )
     end
 
-    response
+    return response.parse
   end
 
   def get_new_story_ids(print: nil)
-    url = @_base_url + "/newstories.json"
-    params = {}
+    _url = @_base_url + "/newstories.json"
+    _kwargs = {
+      params: {}
+    }
     if print != nil
-      params[:print] = print
+       _kwargs[:params][:"print"] = print
     end
+    _http_client, _req_kwargs = self._client_with_auth(
+      [],
+      **_kwargs
+    )
 
     
-    response = @_client.get(
-      url,
-      :params => params,
+    response = _http_client.get(
+      _url,
       
+      **_req_kwargs
     )
-    if response.status.success?
-      response = response.parse
-    else
+    if !response.status.success?
       raise RequestError.new(
         status_code=response.status,
         method="get",
@@ -199,25 +326,29 @@ class Client
       )
     end
 
-    response
+    return response.parse
   end
 
   def get_show_story_ids(print: nil)
-    url = @_base_url + "/showstories.json"
-    params = {}
+    _url = @_base_url + "/showstories.json"
+    _kwargs = {
+      params: {}
+    }
     if print != nil
-      params[:print] = print
+       _kwargs[:params][:"print"] = print
     end
+    _http_client, _req_kwargs = self._client_with_auth(
+      [],
+      **_kwargs
+    )
 
     
-    response = @_client.get(
-      url,
-      :params => params,
+    response = _http_client.get(
+      _url,
       
+      **_req_kwargs
     )
-    if response.status.success?
-      response = response.parse
-    else
+    if !response.status.success?
       raise RequestError.new(
         status_code=response.status,
         method="get",
@@ -226,25 +357,29 @@ class Client
       )
     end
 
-    response
+    return response.parse
   end
 
   def get_top_story_ids(print: nil)
-    url = @_base_url + "/topstories.json"
-    params = {}
+    _url = @_base_url + "/topstories.json"
+    _kwargs = {
+      params: {}
+    }
     if print != nil
-      params[:print] = print
+       _kwargs[:params][:"print"] = print
     end
+    _http_client, _req_kwargs = self._client_with_auth(
+      [],
+      **_kwargs
+    )
 
     
-    response = @_client.get(
-      url,
-      :params => params,
+    response = _http_client.get(
+      _url,
       
+      **_req_kwargs
     )
-    if response.status.success?
-      response = response.parse
-    else
+    if !response.status.success?
       raise RequestError.new(
         status_code=response.status,
         method="get",
@@ -253,25 +388,29 @@ class Client
       )
     end
 
-    response
+    return response.parse
   end
 
   def get_updates(print: nil)
-    url = @_base_url + "/updates.json"
-    params = {}
+    _url = @_base_url + "/updates.json"
+    _kwargs = {
+      params: {}
+    }
     if print != nil
-      params[:print] = print
+       _kwargs[:params][:"print"] = print
     end
+    _http_client, _req_kwargs = self._client_with_auth(
+      [],
+      **_kwargs
+    )
 
     
-    response = @_client.get(
-      url,
-      :params => params,
+    response = _http_client.get(
+      _url,
       
+      **_req_kwargs
     )
-    if response.status.success?
-      response = response.parse
-    else
+    if !response.status.success?
       raise RequestError.new(
         status_code=response.status,
         method="get",
@@ -280,26 +419,29 @@ class Client
       )
     end
 
-    response = GetUpdatesJSONResponse.from_dynamic!(response)
-    response
+    return response.parse
   end
 
-  def get_user(id:, print: nil)
-    url = @_base_url + "/user/#{id}.json"
-    params = {}
+  def get_user(id, print: nil)
+    _url = @_base_url + "/user/#{id}.json"
+    _kwargs = {
+      params: {}
+    }
     if print != nil
-      params[:print] = print
+       _kwargs[:params][:"print"] = print
     end
+    _http_client, _req_kwargs = self._client_with_auth(
+      [],
+      **_kwargs
+    )
 
     
-    response = @_client.get(
-      url,
-      :params => params,
+    response = _http_client.get(
+      _url,
       
+      **_req_kwargs
     )
-    if response.status.success?
-      response = response.parse
-    else
+    if !response.status.success?
       raise RequestError.new(
         status_code=response.status,
         method="get",
@@ -308,8 +450,7 @@ class Client
       )
     end
 
-    response = User.from_dynamic!(response)
-    response
+    return response.parse
   end
 
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: sideko_hacker_news
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.2.0
 platform: ruby
 authors:
 - Sideko
-autorequire:
+autorequire: 
 bindir: bin
 cert_chain: []
-date: 2023-10-12 00:00:00.000000000 Z
+date: 2023-12-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: http
@@ -24,40 +24,6 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 5.1.1
-- !ruby/object:Gem::Dependency
-  name: dry-struct
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.6'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.6'
-- !ruby/object:Gem::Dependency
-  name: dry-types
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.7'
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 1.7.1
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.7'
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 1.7.1
 description: |
   Hacker News makes the public their data available in near real time.
   > The v0 API is essentially a dump of our in-memory data structures. We know, what works great locally in memory isn't so hot over the network. Many of the awkward things are just the way HN works internally... It's not the ideal public API, but it's the one we could release in the time we had
@@ -70,13 +36,12 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- lib/schemas.rb
 - lib/sideko_hacker_news.rb
-homepage:
+homepage: 
 licenses:
 - MIT
 metadata: {}
-post_install_message:
+post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
@@ -91,8 +56,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.10
-signing_key:
+rubygems_version: 3.3.5
+signing_key: 
 specification_version: 4
-summary: sideko_hacker_news 0.1.0
+summary: sideko_hacker_news 0.2.0
 test_files: []

data/lib/schemas.rb

@@ -1,157 +0,0 @@
-
-require 'json'
-require 'dry-types'
-require 'dry-struct'
-
-module Types
-  include Dry.Types(default: :nominal)
-
-  Integer = Strict::Integer
-  Bool    = Strict::Bool
-  Hash    = Strict::Hash
-  String  = Strict::String
-end
-
-class GetUpdatesJSONResponse < Dry::Struct
-
-  # Changed items
-  attribute :items, Types.Array(Types::Integer).optional
-
-  # Changed profiles
-  attribute :profiles, Types.Array(Types::String).optional
-
-  def self.from_dynamic!(d)
-    d = Types::Hash[d]
-    new(
-      items:    d["items"],
-      profiles: d["profiles"],
-    )
-  end
-
-  def self.from_json!(json)
-    from_dynamic!(JSON.parse(json))
-  end
-
-  def to_dynamic
-    {
-      "items"    => items,
-      "profiles" => profiles,
-    }
-  end
-
-  def to_json(options = nil)
-    JSON.generate(to_dynamic, options)
-  end
-end
-
-class Item < Dry::Struct
-  attribute :by,          Types::String
-  attribute :dead,        Types::Bool.optional
-  attribute :deleted,     Types::Bool.optional
-  attribute :descendants, Types::Integer.optional
-  attribute :id,          Types::Integer
-  attribute :kids,        Types.Array(Types::Integer).optional
-  attribute :parent,      Types::Integer.optional
-  attribute :parts,       Types.Array(Types::Integer).optional
-  attribute :poll,        Types::Integer.optional
-  attribute :score,       Types::Integer.optional
-  attribute :text,        Types::String.optional
-  attribute :time,        Types::Integer
-  attribute :title,       Types::String.optional
-  attribute :item_type,   Types::String
-  attribute :url,         Types::String.optional
-
-  def self.from_dynamic!(d)
-    d = Types::Hash[d]
-    new(
-      by:          d.fetch("by"),
-      dead:        d["dead"],
-      deleted:     d["deleted"],
-      descendants: d["descendants"],
-      id:          d.fetch("id"),
-      kids:        d["kids"],
-      parent:      d["parent"],
-      parts:       d["parts"],
-      poll:        d["poll"],
-      score:       d["score"],
-      text:        d["text"],
-      time:        d.fetch("time"),
-      title:       d["title"],
-      item_type:   d.fetch("type"),
-      url:         d["url"],
-    )
-  end
-
-  def self.from_json!(json)
-    from_dynamic!(JSON.parse(json))
-  end
-
-  def to_dynamic
-    {
-      "by"          => by,
-      "dead"        => dead,
-      "deleted"     => deleted,
-      "descendants" => descendants,
-      "id"          => id,
-      "kids"        => kids,
-      "parent"      => parent,
-      "parts"       => parts,
-      "poll"        => poll,
-      "score"       => score,
-      "text"        => text,
-      "time"        => time,
-      "title"       => title,
-      "type"        => item_type,
-      "url"         => url,
-    }
-  end
-
-  def to_json(options = nil)
-    JSON.generate(to_dynamic, options)
-  end
-end
-
-class User < Dry::Struct
-
-  # The user's optional self-description. HTML
-  attribute :about, Types::String.optional
-
-  # Creation date of the user, in Unix Time
-  attribute :created, Types::Integer.optional
-
-  attribute :id, Types::String.optional
-
-  # The user's karma
-  attribute :karma, Types::Integer.optional
-
-  attribute :submitted, Types::Any.optional
-
-  def self.from_dynamic!(d)
-    d = Types::Hash[d]
-    new(
-      about:     d["about"],
-      created:   d["created"],
-      id:        d["id"],
-      karma:     d["karma"],
-      submitted: d["submitted"],
-    )
-  end
-
-  def self.from_json!(json)
-    from_dynamic!(JSON.parse(json))
-  end
-
-  def to_dynamic
-    {
-      "about"     => about,
-      "created"   => created,
-      "id"        => id,
-      "karma"     => karma,
-      "submitted" => submitted,
-    }
-  end
-
-  def to_json(options = nil)
-    JSON.generate(to_dynamic, options)
-  end
-end