shep 0.1.0.pre.alpha0

data/spec/session_writer_spec.rb

@@ -0,0 +1,183 @@
+
+require 'fileutils'
+
+require_relative 'spec_helper'
+require_relative '../lib/shep'
+
+include Shep
+
+POST_UUID = "fc49e486-d445-4ca7-9d6d-a27c89c5c471"  #SecureRandom.uuid
+
+describe Session, :account_limited do
+  include_context :uses_temp_dir
+
+  before(:all) {
+    @new_posts = []
+  }
+
+  it "posts statuses" do
+    testpost = "Test post #{POST_UUID} "
+
+    ss = Session.new(host: HOST, token: TOKEN)
+
+    visibilities = %w{public unlisted private direct}
+    for vis in visibilities
+      post = ss.post_status(testpost + Time.now.to_s,
+                            visibility: vis,
+                            language: "en")
+      @new_posts.push post
+
+      expect( visibilities.index(post.visibility) )
+        .to be >= visibilities.index(vis)
+
+      retrieved_post = ss.fetch_status(post.id)
+      expect( retrieved_post ) .to eq post
+    end
+
+    spoiler_text = "is this a test post?"
+    post = ss.post_status(testpost + Time.now.to_s,
+                          spoiler_text: spoiler_text)
+    @new_posts.push post
+    expect( post.spoiler_text ) .to eq spoiler_text
+    expect( post.sensitive ) .to be true
+
+    retrieved_post = ss.fetch_status(post.id)
+    expect( retrieved_post ) .to eq post
+  end
+
+  it "posts status with media" do
+    ss = Session.new(host: HOST, token: TOKEN)
+
+    file1 = File.join(File.dirname(__FILE__), "data", "smallimg.jpg")
+    file2 = File.join(File.dirname(__FILE__), "data", "smallish.jpg")
+
+    img1 = ss.upload_media(file1, content_type: 'image/jpeg')
+    expect( img1.type ) .to eq 'image'
+
+    desc = "IMAGE_TEXT!!!!"
+    img2 = ss.upload_media(file2,
+                           description: desc,
+                           focus_x: 0.0,
+                           focus_y: 0.7)
+    expect( img2.type ) .to eq 'image'
+    expect( img2.description ) .to eq  desc
+
+    msg = "Upload unit test post; #{Time.now.iso8601}; #{POST_UUID}"
+    post = ss.post_status(msg, media_ids: [img1.id, img2.id])
+    @new_posts.push(post)   # so it gets deleted later
+
+    post2, files = ss.fetch_status_with_media(post.id, tmp_dir())
+    expect( post2.media_attachments[0].id ) .to eq img1.id
+    expect( post2.media_attachments[1].id ) .to eq img2.id
+
+    # It turns out that Mastodon modifies the image files so that what
+    # we get back isn't bit-identical to what we uploaded.  Since
+    # there's no bulletproof way to extract stuff like extent from the
+    # image, we settle for just confirming that we get the correct
+    # number of onon-empty files.
+    expect( files.size ) .to eq 2
+    for path in files.values
+      expect( File.stat(path).size ) .to be > 1000
+    end
+  end
+
+  it "edits statuses" do
+    ss = Session.new(host: HOST, token: TOKEN)
+
+    base_text = "edited msg #{POST_UUID}\n#{Time.now}\n-"
+    post = ss.post_status(base_text, language: "en")
+    @new_posts.push(post)   # delete it during the deletion test
+
+    expect( ss.fetch_status(post.id) ) .to eq post
+    expect( post.content )      .to include POST_UUID
+    expect( post.sensitive )    .to be false
+    expect( post.spoiler_text ) .to eq ""
+    expect( post.language )     .to eq "en"
+
+    src = ss.fetch_status_src(post.id)
+    expect(src.text) .to eq base_text
+
+    # Edit to update the text.
+    new_text = base_text + "!!!!"
+    post2 = ss.edit_status(post.id, new_text)
+    expect( ss.fetch_status(post.id) ) .to eq post2
+
+    expect( post2.content )      .to include '!!!'
+    expect( post2.sensitive )    .to be false
+    expect( post2.spoiler_text ) .to eq ""
+    expect( post2.language )     .to eq "en"
+
+    # Edit to change language, spoiler and sensitive
+    post2 = ss.edit_status(post.id, new_text,
+                           spoiler_text: "spoiler",
+                           language: "fr")
+    expect( ss.fetch_status(post.id) ) .to eq post2
+
+    expect( post2.content )      .to include '!!!'
+    expect( post2.sensitive )    .to be true
+    expect( post2.spoiler_text ) .to eq "spoiler"
+    expect( post2.language )     .to eq "fr"
+
+    # Edit to revert sensitive and language
+    post2 = ss.edit_status(post.id, new_text)
+    expect( ss.fetch_status(post.id) ) .to eq post2
+
+    expect( post2.content )      .to include '!!!'
+    expect( post2.sensitive )    .to be false
+    expect( post2.spoiler_text ) .to eq ""
+    expect( post2.language )     .to eq "en"
+
+    # Edit to add a media attachment
+    file1 = File.join(File.dirname(__FILE__), "data", "smallimg.jpg")
+    img1 = ss.upload_media(file1, content_type: 'image/jpeg')
+
+    new_text2 = new_text + "\n!PIX!\n"
+    post2 = ss.edit_status(post.id, new_text2,
+                           spoiler_text: "pix",
+                           media_ids: [img1.id],
+                          )
+    expect( ss.fetch_status(post.id) ) .to eq post2
+
+    expect( post2.content )      .to include '!PIX!'
+    expect( post2.sensitive )    .to be true
+    expect( post2.spoiler_text ) .to eq "pix"
+    expect( post2.language )     .to eq "en"
+    expect( post2.media_attachments.map{|ma| ma.id} )
+      .to eq [img1.id]
+
+    # Edit to remove the media attachment
+    post2 = ss.edit_status(post.id, new_text2,
+                           spoiler_text: "pix",
+                           media_ids: [],
+                          )
+    expect( ss.fetch_status(post.id) ) .to eq post2
+
+    expect( post2.content )      .to include '!PIX!'
+    expect( post2.sensitive )    .to be true
+    expect( post2.spoiler_text ) .to eq "pix"
+    expect( post2.language )     .to eq "en"
+    expect( post2.media_attachments ) .to eq []
+  end
+
+  it "deletes statuses" do
+    ss = Session.new(host: HOST, token: TOKEN)
+
+    # Test for the test itself
+    expect( @new_posts.size ) .to be > 0
+
+    # Fun fact: a Mastodon instance limits deletions to 30/hour, so
+    # running this test a few times will completely eat through that.
+    @new_posts.each do |status|
+      del_post = ss.delete_status(status.id)
+      expect( del_post.id ) .to eq status.id
+      expect( del_post.text.include? POST_UUID ) .to be true
+    end
+
+    @new_posts = []
+  end
+
+
+  # skip "" do ; end
+  # skip "" do ; end
+
+end

data/spec/spec_helper.rb

@@ -0,0 +1,73 @@
+
+$: << 'lib'
+
+require 'tmpdir'
+
+# The Mastodon instance to use for online testing
+HOST                    = ENV['SHEP_TEST_HOST']
+
+# Public account on HOST to use for unauthenticated feature testing
+READ_ACCOUNT_HANDLE     = ENV['SHEP_READ_ACCOUNT_HANDLE']
+READ_ACCOUNT            = ENV['SHEP_READ_ACCOUNT']
+
+# Account details on HOST to use for authenticated/write feature
+# testing
+TOKEN                   = ENV['SHEP_TOKEN']
+WRITE_ACCOUNT           = ENV['SHEP_ACCOUNT']
+
+# If set and everything else is in order, we also run the rate-limited
+# tests.
+ALL_TESTS_REQUESTED     = !!ENV['SHEP_TEST_ALL']
+
+
+# Tags:
+#
+#   offline         - runs without a Mastodon server
+#   anonymous       - requires a server but no login
+#   account         - requires normal server account (which it *may* modify!)
+#   account_limited - like 'account' but will also perform heavily
+#                     rate-limited actions (e.g. delete, upload media)
+
+
+RSpec.configure {|conf|
+  if conf.inclusion_filter.empty?
+    allow_anonymous     = HOST && READ_ACCOUNT && READ_ACCOUNT_HANDLE
+    allow_account       = allow_anonymous && TOKEN && WRITE_ACCOUNT
+    allow_limited       = allow_account && ALL_TESTS_REQUESTED
+
+    if ALL_TESTS_REQUESTED && !allow_limited
+      puts "Requested all tests but some parameters are missing."
+      # I suppose I should say which...
+      exit 1
+    end
+
+    puts "Test groups chosen:"
+    if allow_limited
+      puts "  * all tests"
+    else
+      puts "  * offline tests"
+      puts "  * anonymous online tests"         if allow_anonymous
+      puts "  * authenticated online test"      if allow_account
+    end
+    puts
+
+    conf.filter_run_including(:offline)
+    conf.filter_run_including(:anonymous) if allow_anonymous
+    conf.filter_run_including(:account) if allow_account
+    conf.filter_run_including(:account_limited) if allow_limited
+  end
+
+  conf.default_formatter = 'doc'
+}
+
+# stolen from https://gist.github.com/sue445/d840d6f68771a14a48fc
+shared_context :uses_temp_dir do
+  around do |example|
+    Dir.mktmpdir("rspec-") do |dir|
+      @tmp_dir = dir
+      example.run
+    end
+  end
+
+  attr_reader :tmp_dir
+end

data/yard_helper.rb

@@ -0,0 +1,30 @@
+
+require_relative "lib/shep.rb"
+
+class EntityFieldDeclHandler < YARD::Handlers::Ruby::Base  #AttributeHandler
+  handles method_call(:fields)
+  namespace_only
+
+  process do
+    mastotype = namespace.name.to_s.gsub(/_/, '::')
+    new_docstr = "Ruby object representing a Mastodon `#{mastotype}` object:\n\n"
+
+    nnt = Object.const_get(namespace.path).send(:names_and_types)
+    nnt.each do |name, type|
+      # We generate the argument list in Markdown because I am
+      # completely done fighting with YARD to get it to recognize my
+      # 'attr' tags.
+
+      new_docstr += " * #{name} (#{type.to_yard_s})\n"
+    end
+    
+    new_docstr += "\n"
+    new_docstr += "See `Shep::Entity` for an overview.\n\n"
+    new_docstr += namespace.docstring.to_raw.strip
+
+    namespace.docstring.replace(new_docstr)
+  end
+end
+
+
+

metadata

@@ -0,0 +1,154 @@
+--- !ruby/object:Gem::Specification
+name: shep
+version: !ruby/object:Gem::Version
+  version: 0.1.0.pre.alpha0
+platform: ruby
+authors:
+- Chris Reuter
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2023-06-03 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.12.0
+  name: rspec
+  prerelease: false
+  type: :development
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.12.0
+- !ruby/object:Gem::Dependency
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.9.34
+  name: yard
+  prerelease: false
+  type: :development
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.9.34
+- !ruby/object:Gem::Dependency
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 13.0.6
+  name: rake
+  prerelease: false
+  type: :development
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 13.0.6
+description: |
+  Shep is a library that provides access to the Mastodon Web API.  It
+  has no gem dependencies beyond the base Ruby (3.0.x) installation and
+  can be tested without a dedicated Mastodon server.  It is intended as
+  a slightly more feature-rich alternative to the mastodon-api gem.
+email: chris@isplitonyourgrave.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- Copyright.txt
+- LICENSE.txt
+- README.md
+- Rakefile
+- doc/Shep.html
+- doc/Shep/Entity.html
+- doc/Shep/Entity/Account.html
+- doc/Shep/Entity/Context.html
+- doc/Shep/Entity/CustomEmoji.html
+- doc/Shep/Entity/MediaAttachment.html
+- doc/Shep/Entity/Notification.html
+- doc/Shep/Entity/Status.html
+- doc/Shep/Entity/StatusSource.html
+- doc/Shep/Entity/Status_Application.html
+- doc/Shep/Entity/Status_Mention.html
+- doc/Shep/Entity/Status_Tag.html
+- doc/Shep/Error.html
+- doc/Shep/Error/Caller.html
+- doc/Shep/Error/Http.html
+- doc/Shep/Error/Remote.html
+- doc/Shep/Error/Server.html
+- doc/Shep/Error/Type.html
+- doc/Shep/Session.html
+- doc/_index.html
+- doc/class_list.html
+- doc/css/common.css
+- doc/css/full_list.css
+- doc/css/style.css
+- doc/file.README.html
+- doc/file_list.html
+- doc/frames.html
+- doc/index.html
+- doc/js/app.js
+- doc/js/full_list.js
+- doc/js/jquery.js
+- doc/method_list.html
+- doc/top-level-namespace.html
+- lib/shep.rb
+- lib/shep/entities.rb
+- lib/shep/entity_base.rb
+- lib/shep/exceptions.rb
+- lib/shep/session.rb
+- lib/shep/typeboxes.rb
+- run_rake_test.example.sh
+- shep.gemspec
+- spec/data/smallimg.jpg
+- spec/data/smallish.jpg
+- spec/entity_common.rb
+- spec/entity_t1_spec.rb
+- spec/entity_t2_spec.rb
+- spec/entity_t3_spec.rb
+- spec/json_objects/account.1.json
+- spec/json_objects/account.2.json
+- spec/json_objects/status.1.json
+- spec/json_objects/status.2.json
+- spec/json_objects/status.3.json
+- spec/json_objects/status.4.json
+- spec/json_objects/status.5.json
+- spec/json_objects/status.6.json
+- spec/json_objects/status.7.json
+- spec/session_reader_1_unauth_spec.rb
+- spec/session_reader_2_auth_spec.rb
+- spec/session_writer_spec.rb
+- spec/spec_helper.rb
+- yard_helper.rb
+homepage: https://codeberg.org/suetanvil/shep
+licenses:
+- AGPL with linking exemption
+metadata: {}
+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: 1.3.1
+requirements:
+- A Ruby implementing 3.0.x syntax and the standard libs.
+rubygems_version: 3.3.25
+signing_key:
+specification_version: 4
+summary: An alternate interface to the Mastodon Web API
+test_files: []