sferik 0.0.1

data/lib/sferik/resume/profile.rb

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+require_relative "../resource"
+
+module Sferik
+  class Resume < Resource
+    # A profile elsewhere, as returned in {Basics#profiles}
+    # @api public
+    class Profile < Resource
+      # @!method network
+      #   The network
+      #   @api public
+      #   @return [String] the network
+      #   @example
+      #     profile.network # => "GitHub"
+      attribute :network
+
+      # @!method username
+      #   The username there
+      #   @api public
+      #   @return [String] the username there
+      #   @example
+      #     profile.username # => "sferik"
+      attribute :username
+
+      # @!method url
+      #   The profile
+      #   @api public
+      #   @return [String] the profile
+      #   @example
+      #     profile.url # => "https://github.com/sferik"
+      attribute :url
+    end
+  end
+end

data/lib/sferik/resume/project.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+require_relative "../resource"
+
+module Sferik
+  class Resume < Resource
+    # Open source work, as returned in {Resume#projects}
+    # @api public
+    class Project < Resource
+      # @!method name
+      #   The projects
+      #   @api public
+      #   @return [String] the projects
+      #   @example
+      #     project.name # => "RubyGems.org"
+      attribute :name
+
+      # @!method description
+      #   What Erik did
+      #   @api public
+      #   @return [String] what Erik did
+      #   @example
+      #     project.description # => "top contributor (1,900+ commits)..."
+      attribute :description
+    end
+  end
+end

data/lib/sferik/resume/skill.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+require_relative "../resource"
+
+module Sferik
+  class Resume < Resource
+    # A group of skills, as returned in {Resume#skills}
+    # @api public
+    class Skill < Resource
+      # @!method name
+      #   The group
+      #   @api public
+      #   @return [String] the group
+      #   @example
+      #     skill.name # => "Languages"
+      attribute :name
+
+      # @!method keywords
+      #   The skills
+      #   @api public
+      #   @return [Array<String>] the skills
+      #   @example
+      #     skill.keywords # => ["Ruby", "Rust", ...]
+      list :keywords
+    end
+  end
+end

data/lib/sferik/resume/speaking.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+require_relative "../resource"
+
+module Sferik
+  class Resume < Resource
+    # Speaking, as returned by {Resume#speaking} (an addition to JSON Resume)
+    # @api public
+    class Speaking < Resource
+      # @!method summary
+      #   A summary of talks, with *italic* titles
+      #   @api public
+      #   @return [String] a summary of talks, with *italic* titles
+      #   @example
+      #     speaking.summary # => "Spoke at 17 conferences in 13 countries..."
+      attribute :summary
+    end
+  end
+end

data/lib/sferik/resume/volunteer.rb

@@ -0,0 +1,59 @@
+# frozen_string_literal: true
+
+require_relative "../resource"
+
+module Sferik
+  class Resume < Resource
+    # A volunteer role, as returned in {Resume#volunteer}
+    # @api public
+    class Volunteer < Resource
+      # @!method position
+      #   The role
+      #   @api public
+      #   @return [String] the role
+      #   @example
+      #     role.position # => "Board of Directors"
+      attribute :position
+
+      # @!method organization
+      #   The organization
+      #   @api public
+      #   @return [String] the organization
+      #   @example
+      #     role.organization # => "Pacific Primary"
+      attribute :organization
+
+      # @!method start_date
+      #   When it started, as the first day of the month or year given
+      #   @api public
+      #   @return [Date] when it started, as the first day of the month or year given
+      #   @example
+      #     role.start_date # => #<Date: 2023-09-01>
+      timestamp :start_date, PartialDate
+
+      # @!method end_date
+      #   When it ended, or nil if it hasn't
+      #   @api public
+      #   @return [Date, nil] when it ended, or nil if it hasn't
+      #   @example
+      #     role.end_date # => #<Date: 2026-01-01>
+      timestamp :end_date, PartialDate
+
+      # @!method summary
+      #   What Erik did
+      #   @api public
+      #   @return [String, nil] what Erik did
+      #   @example
+      #     role.summary # => "President 2025–2026, Treasurer 2024–2025..."
+      attribute :summary
+
+      # @!method url
+      #   The organization's site
+      #   @api public
+      #   @return [String, nil] the organization's site
+      #   @example
+      #     role.url # => "https://pacificprimary.org"
+      attribute :url
+    end
+  end
+end

data/lib/sferik/resume/work.rb

@@ -0,0 +1,51 @@
+# frozen_string_literal: true
+
+require_relative "../resource"
+
+module Sferik
+  class Resume < Resource
+    # A job, as returned in {Resume#work}
+    # @api public
+    class Work < Resource
+      # @!method position
+      #   The title
+      #   @api public
+      #   @return [String] the title
+      #   @example
+      #     work.position # => "Software Engineering Manager"
+      attribute :position
+
+      # @!method name
+      #   The company
+      #   @api public
+      #   @return [String] the company
+      #   @example
+      #     work.name # => "Twitter"
+      attribute :name
+
+      # @!method start_date
+      #   When it started, as the first day of the month or year given
+      #   @api public
+      #   @return [Date] when it started, as the first day of the month or year given
+      #   @example
+      #     work.start_date # => #<Date: 2021-01-01>
+      timestamp :start_date, PartialDate
+
+      # @!method end_date
+      #   When it ended, or nil if it hasn't
+      #   @api public
+      #   @return [Date, nil] when it ended, or nil if it hasn't
+      #   @example
+      #     work.end_date # => #<Date: 2023-01-01>
+      timestamp :end_date, PartialDate
+
+      # @!method highlights
+      #   What Erik did there
+      #   @api public
+      #   @return [Array<String>] what Erik did there
+      #   @example
+      #     work.highlights # => ["Led the engineering team that built Subscriptions..."]
+      list :highlights
+    end
+  end
+end

data/lib/sferik/resume.rb

@@ -0,0 +1,125 @@
+# frozen_string_literal: true
+
+require_relative "resource"
+require_relative "resume/award"
+require_relative "resume/basics"
+require_relative "resume/education"
+require_relative "resume/meta"
+require_relative "resume/patent"
+require_relative "resume/project"
+require_relative "resume/skill"
+require_relative "resume/speaking"
+require_relative "resume/volunteer"
+require_relative "resume/work"
+
+module Sferik
+  # The resume, a JSON Resume document (https://jsonresume.org/schema), as returned by {API::ResumeEndpoints#resume}
+  #
+  # Its sections are objects of their own, under this class: {Basics}, {Work}, {Award}, and so on.
+  # @api public
+  class Resume < Resource
+    # @!method basics
+    #   The name, contact details, summary, and location
+    #   @api public
+    #   @return [Basics] the name, contact details, summary, and location
+    #   @example
+    #     resume.basics # => #<Sferik::Resume::Basics ...>
+    attribute :basics, "basics", type: Basics
+
+    # @!method work
+    #   Jobs, newest first
+    #   @api public
+    #   @return [Array<Work>] jobs, newest first
+    #   @example
+    #     resume.work # => [#<Sferik::Resume::Work ...>, ...]
+    list :work, "work", type: Work
+
+    # @!method projects
+    #   Open source work
+    #   @api public
+    #   @return [Array<Project>] open source work
+    #   @example
+    #     resume.projects # => [#<Sferik::Resume::Project ...>, ...]
+    list :projects, "projects", type: Project
+
+    # @!method skills
+    #   Skills, by group
+    #   @api public
+    #   @return [Array<Skill>] skills, by group
+    #   @example
+    #     resume.skills # => [#<Sferik::Resume::Skill ...>]
+    list :skills, "skills", type: Skill
+
+    # @!method awards
+    #   Honors
+    #   @api public
+    #   @return [Array<Award>] honors
+    #   @example
+    #     resume.awards # => [#<Sferik::Resume::Award ...>, ...]
+    list :awards, "awards", type: Award
+
+    # @!method patents
+    #   Patents
+    #   @api public
+    #   @return [Array<Patent>] patents
+    #   @example
+    #     resume.patents # => [#<Sferik::Resume::Patent ...>, ...]
+    list :patents, "patents", type: Patent
+
+    # @!method speaking
+    #   A summary of talks
+    #   @api public
+    #   @return [Speaking] a summary of talks
+    #   @example
+    #     resume.speaking # => #<Sferik::Resume::Speaking ...>
+    attribute :speaking, "speaking", type: Speaking
+
+    # @!method education
+    #   Schools
+    #   @api public
+    #   @return [Array<Education>] schools
+    #   @example
+    #     resume.education # => [#<Sferik::Resume::Education ...>]
+    list :education, "education", type: Education
+
+    # @!method volunteer
+    #   Service
+    #   @api public
+    #   @return [Array<Volunteer>] service
+    #   @example
+    #     resume.volunteer # => [#<Sferik::Resume::Volunteer ...>, ...]
+    list :volunteer, "volunteer", type: Volunteer
+
+    # @!method meta
+    #   What the resume says about itself, or nil if it says nothing
+    #   @api public
+    #   @return [Meta, nil] what the resume says about itself, or nil if it says nothing
+    #   @example
+    #     resume.meta # => #<Sferik::Resume::Meta ...>
+    attribute :meta, "meta", type: Meta
+
+    inspect_with :name
+
+    # The name on the resume, from {#basics}
+    #
+    # @api public
+    # @return [String, nil] the name
+    # @example
+    #   resume.name # => "Erik Berlin"
+    def name
+      basics&.name
+    end
+    record :name
+
+    # When the resume last changed, from {#meta}
+    #
+    # @api public
+    # @return [Date, nil] when the resume last changed
+    # @example
+    #   resume.last_modified # => #<Date: 2026-10-01>
+    def last_modified
+      meta&.last_modified
+    end
+    record :last_modified
+  end
+end

data/lib/sferik/session.rb

@@ -0,0 +1,41 @@
+# frozen_string_literal: true
+
+require_relative "resource"
+
+module Sferik
+  # A reader's terminal, one per browser tab, as returned in {Who#users}
+  # @api public
+  class Session < Resource
+    # @!method tty
+    #   The terminal's name
+    #   @api public
+    #   @return [String] the terminal's name
+    #   @example
+    #     session.tty # => "ttys001"
+    attribute :tty
+
+    # @!method page
+    #   The page the tab is on
+    #   @api public
+    #   @return [String] the page the tab is on
+    #   @example
+    #     session.page # => "/talks"
+    attribute :page
+
+    # @!method login
+    #   When the tab opened
+    #   @api public
+    #   @return [Time] when the tab opened
+    #   @example
+    #     session.login # => 2026-10-06 12:00:00 UTC
+    timestamp :login, Time
+
+    # @!method idle
+    #   The seconds since the tab last checked in
+    #   @api public
+    #   @return [Integer] the seconds since the tab last checked in
+    #   @example
+    #     session.idle # => 42
+    attribute :idle
+  end
+end

data/lib/sferik/social_profile.rb

@@ -0,0 +1,49 @@
+# frozen_string_literal: true
+
+require_relative "resource"
+
+module Sferik
+  # A profile elsewhere, such as GitHub or Mastodon, as listed by {API::ProfileEndpoints#finger}
+  # @api public
+  class SocialProfile < Resource
+    # @!method network
+    #   The name of the network
+    #   @api public
+    #   @return [String] the name of the network
+    #   @example
+    #     profile.network # => "GitHub"
+    attribute :network
+
+    # @!method username
+    #   The username on that network
+    #   @api public
+    #   @return [String] the username on that network
+    #   @example
+    #     profile.username # => "sferik"
+    attribute :username
+
+    # @!method url
+    #   The URL of the profile
+    #   @api public
+    #   @return [String] the URL of the profile
+    #   @example
+    #     profile.url # => "https://github.com/sferik"
+    attribute :url
+
+    # @!method icon
+    #   The id of the profile's icon in https://sferik.net/icons.svg
+    #   @api public
+    #   @return [String] the id of the profile's icon in https://sferik.net/icons.svg
+    #   @example
+    #     profile.icon # => "github"
+    attribute :icon
+
+    # @!method aliases
+    #   The names the site's shell accepts for `open`
+    #   @api public
+    #   @return [Array<String>] the names the site's shell accepts for `open`
+    #   @example
+    #     profile.aliases # => ["github", "gh"]
+    list :aliases
+  end
+end

data/lib/sferik/status/github.rb

@@ -0,0 +1,38 @@
+# frozen_string_literal: true
+
+require_relative "../resource"
+
+module Sferik
+  class Status < Resource
+    # What became of asking GitHub with the site's token, as returned by {Status#github}
+    #
+    # A copy of the site that has no token, or hasn't asked yet, has nil for each.
+    #
+    # @api public
+    class GitHub < Resource
+      # @!method asked
+      #   When GitHub was last asked with the token
+      #   @api public
+      #   @return [Time, nil] when GitHub was last asked with the token
+      #   @example
+      #     github.asked # => 2026-10-08 21:45:07 UTC
+      timestamp :asked, Time
+
+      # @!method answered
+      #   When GitHub last answered: when it was asked, if the last answer came
+      #   @api public
+      #   @return [Time, nil] when GitHub last answered: when it was asked, if the last answer came
+      #   @example
+      #     github.answered # => 2026-10-08 21:45:07 UTC
+      timestamp :answered, Time
+
+      # @!method error
+      #   What went wrong the last time GitHub was asked
+      #   @api public
+      #   @return [String, nil] what went wrong the last time GitHub was asked, or nil if it answered
+      #   @example
+      #     github.error # => "https://api.github.com/graphql: 401"
+      attribute :error
+    end
+  end
+end

data/lib/sferik/status/loaded.rb

@@ -0,0 +1,48 @@
+# frozen_string_literal: true
+
+require_relative "../resource"
+
+module Sferik
+  class Status < Resource
+    # When the site last loaded each of its live values, as returned by {Status#loaded}
+    #
+    # {Projects#as_of} and {Contributions#as_of} say so of the downloads and the contributions, and nothing else does
+    # of the stars and the latest push. One that has never been loaded is nil: on a copy of the site that's offline,
+    # each is.
+    #
+    # @api public
+    class Loaded < Resource
+      # @!method gems
+      #   When the downloads were last loaded, from RubyGems
+      #   @api public
+      #   @return [Time, nil] when the downloads were last loaded, from RubyGems
+      #   @example
+      #     loaded.gems # => 2026-10-08 21:45:07 UTC
+      timestamp :gems, Time
+
+      # @!method stars
+      #   When the stars were last loaded, from GitHub
+      #   @api public
+      #   @return [Time, nil] when the stars were last loaded, from GitHub
+      #   @example
+      #     loaded.stars # => 2026-10-08 21:45:07 UTC
+      timestamp :stars, Time
+
+      # @!method contributions
+      #   When the year of contributions was last loaded, from GitHub
+      #   @api public
+      #   @return [Time, nil] when the year of contributions was last loaded, from GitHub
+      #   @example
+      #     loaded.contributions # => 2026-10-08 21:45:07 UTC
+      timestamp :contributions, Time
+
+      # @!method push
+      #   When the latest push was last loaded, from GitHub
+      #   @api public
+      #   @return [Time, nil] when the latest push was last loaded, from GitHub
+      #   @example
+      #     loaded.push # => 2026-10-08 21:45:07 UTC
+      timestamp :push, Time
+    end
+  end
+end

data/lib/sferik/status.rb

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+require_relative "resource"
+require_relative "status/github"
+require_relative "status/loaded"
+
+module Sferik
+  # Whether the site's live numbers come as they should, as returned by {API::SiteEndpoints#status}
+  #
+  # The site asks GitHub for the contributions, the stars, and the latest push in one request, with a token. If that
+  # fails, it asks for each another way, without the token, and the numbers come all the same: {Contributions#live?}
+  # and {Projects#live?} are still true. So this says what became of asking with the token, which nothing else does.
+  # And it says when each live value was last loaded: the stars and the latest push too, which say so nowhere else.
+  #
+  # @api public
+  class Status < Resource
+    # @!method github
+    #   What became of asking GitHub with the site's token
+    #   @api public
+    #   @return [GitHub, nil] what became of asking GitHub with the site's token
+    #   @example
+    #     status.github.answered # => 2026-10-08 21:45:07 UTC
+    attribute :github, type: GitHub
+
+    # @!method loaded
+    #   When the site last loaded each of its live values
+    #   @api public
+    #   @return [Loaded, nil] when the site last loaded each of its live values
+    #   @example
+    #     status.loaded.stars # => 2026-10-08 21:45:07 UTC
+    attribute :loaded, type: Loaded
+  end
+end

data/lib/sferik/talk.rb

@@ -0,0 +1,73 @@
+# frozen_string_literal: true
+
+require_relative "resource"
+
+module Sferik
+  # A conference talk, as returned in {Talks#talks}
+  # @api public
+  class Talk < Resource
+    # @!method title
+    #   The talk's title
+    #   @api public
+    #   @return [String] the talk's title
+    #   @example
+    #     talk.title # => "Writing Fast Ruby"
+    attribute :title
+
+    # @!method event
+    #   The conference
+    #   @api public
+    #   @return [String] the conference
+    #   @example
+    #     talk.event # => "Baruco"
+    attribute :event
+
+    # @!method date
+    #   When it was, to the month: the first day of that month
+    #   @api public
+    #   @return [Date] the first day of the month it was in
+    #   @example
+    #     talk.date # => #<Date: 2014-09-01>
+    timestamp :date, PartialDate
+
+    # @!method location
+    #   Where the conference was
+    #   @api public
+    #   @return [String] where the conference was
+    #   @example
+    #     talk.location # => "Barcelona"
+    attribute :location
+
+    # @!method slides
+    #   The slides, if they're online
+    #   @api public
+    #   @return [String, nil] the slides, if they're online
+    #   @example
+    #     talk.slides # => "https://speakerdeck.com/sferik/writing-fast-ruby"
+    attribute :slides
+
+    # @!method video
+    #   The video, if there is one
+    #   @api public
+    #   @return [String, nil] the video, if there is one
+    #   @example
+    #     talk.video # => "https://www.youtube.com/watch?v=fGFM_UrSp70"
+    attribute :video
+
+    # @!method link
+    #   The talk's page on the event's site, if it has one
+    #   @api public
+    #   @return [String, nil] the talk's page on the event's site, if it has one
+    #   @example
+    #     talk.link # => "https://schedule.sxsw.com/2015/events/event_IAP35000"
+    attribute :link
+
+    # @!method featured?
+    #   Whether the home page shows it
+    #   @api public
+    #   @return [Boolean] whether the home page shows it
+    #   @example
+    #     talk.featured? # => true
+    predicate :featured
+  end
+end