elephrame 0.2.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 898b60769d6d1b3e6cb144017948786c46b39a7afcde1a73da8858f91d8ae425
+  data.tar.gz: fc7e8caf3197c2a4634b325c0535f8d9a05c01e17cc05bc0d13a2ffc35f0ffc5
+SHA512:
+  metadata.gz: 70f4e752ecb1eb3dfc24304539c1c291b7b00a8052a4356858105fc305e83895306f5ae2ca449bccccdd64b26aeafbfe044b69fe78c34a02bb620e0d609fef37
+  data.tar.gz: e94ab3417ab4f45bca3b4e63ba62077932611191fa3eaab634c79fee7981575388dabb3f1b24974fe5a6c9ba5d95b4000c36bcf59aecfd16091ddf640b82f257

data/.gitignore

@@ -0,0 +1,8 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.travis.yml

@@ -0,0 +1,7 @@
+---
+sudo: false
+language: ruby
+cache: bundler
+rvm:
+  - 2.5.3
+before_install: gem install bundler -v 1.17.1

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at thezacattacks@gmail.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,6 @@
+source "https://rubygems.org"
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in elephrame.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,59 @@
+PATH
+  remote: .
+  specs:
+    elephrame (0.2.0)
+      moostodon (~> 0.2.0)
+      rufus-scheduler
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    addressable (2.5.2)
+      public_suffix (>= 2.0.2, < 4.0)
+    buftok (0.2.0)
+    domain_name (0.5.20180417)
+      unf (>= 0.0.5, < 1.0.0)
+    et-orbi (1.1.6)
+      tzinfo
+    fugit (1.1.6)
+      et-orbi (~> 1.1, >= 1.1.6)
+      raabro (~> 1.1)
+    http (3.3.0)
+      addressable (~> 2.3)
+      http-cookie (~> 1.0)
+      http-form_data (~> 2.0)
+      http_parser.rb (~> 0.6.0)
+    http-cookie (1.0.3)
+      domain_name (~> 0.5)
+    http-form_data (2.1.1)
+    http_parser.rb (0.6.0)
+    minitest (5.11.3)
+    moostodon (0.2.0)
+      addressable (~> 2.5)
+      buftok (~> 0)
+      http (~> 3.0)
+      oj (~> 3.3)
+    oj (3.7.1)
+    public_suffix (3.0.3)
+    raabro (1.1.6)
+    rake (10.5.0)
+    rufus-scheduler (3.5.2)
+      fugit (~> 1.1, >= 1.1.5)
+    thread_safe (0.3.6)
+    tzinfo (1.2.5)
+      thread_safe (~> 0.1)
+    unf (0.1.4)
+      unf_ext
+    unf_ext (0.0.7.5)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.17)
+  elephrame!
+  minitest (~> 5.0)
+  rake (~> 10.0)
+
+BUNDLED WITH
+   1.17.1

data/LICENSE

@@ -0,0 +1,20 @@
+
+Copyright (c) 2018, Zachary Epps, thezacattacks@gmail.com
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,39 @@
+# Elephrame
+
+Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/elephrame`. To experiment with that code, run `bin/console` for an interactive prompt.
+
+TODO: Delete this and the text above, and describe your gem
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'elephrame'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install elephrame
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/elephrame. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+## Code of Conduct
+
+Everyone interacting in the Elephrame project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/elephrame/blob/master/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,10 @@
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList["test/**/*_test.rb"]
+end
+
+task :default => :test

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "elephrame"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/elephrame.gemspec

@@ -0,0 +1,46 @@
+
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "elephrame/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "elephrame"
+  spec.version       = Elephrame::VERSION
+  spec.authors       = ["Zac"]
+  spec.email         = ["thezacattacks@gmail.com"]
+  spec.license       = "MIT"
+
+  spec.summary       = %q{A framework for assisting in making mastodon/pleroma bots}
+  spec.homepage      = "https://github.com/theZacAttacks/elephrame"
+
+  # Prevent pushing this gem to RubyGems.org. To allow pushes either set the 'allowed_push_host'
+  # to allow pushing to a single host or delete this section to allow pushing to any host.
+  if spec.respond_to?(:metadata)
+    spec.metadata["allowed_push_host"] = "https://rubygems.org"
+
+    spec.metadata["homepage_uri"] = spec.homepage
+    spec.metadata["source_code_uri"] = spec.homepage
+  else
+    raise "RubyGems 2.0 or newer is required to protect against " \
+      "public gem pushes."
+  end
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.17"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "minitest", "~> 5.0"
+  
+  spec.add_dependency 'rufus-scheduler'
+  spec.add_dependency 'moostodon', '~> 0.2.0'
+  
+  # until mastodon-api gets a bump this stays commented out
+  #spec.add_dependency 'mastodon-api', '> 1.1.0'
+end

data/examples/combined.rb

@@ -0,0 +1,20 @@
+require 'elephrame'
+
+mix = Elephrame::Bots::PeriodInteract.new '30s'
+
+mix.on_reply { |bot, post|
+  bot.post("@#{post.account.acct} Thanks for helping me test stuff :3",
+           reply_id: post.id, visibility: post.visibility)
+}
+
+mix.on_fave { |bot, notif|
+  puts "#{notif.account.acct} just faved post #{notif.status.content}"
+}
+
+mix.on_boost { |bot, notif|
+  puts "#{notif.account.acct} just boosted post #{notif.status.content}"
+}
+
+mix.run do |bot|
+  bot.post('testing', visibility: 'direct')
+end

data/examples/interact.rb

@@ -0,0 +1,18 @@
+require 'elephrame'
+
+interacter = Elephrame::Bots::Interact.new
+
+interacter.on_reply { |bot, post|
+  bot.post("@#{post.account.acct} Thanks for helping me test stuff :3",
+           reply_id: post.id, visibility: post.visibility)
+}
+
+interacter.on_fave { |bot, notif|
+  puts "#{notif.account.acct} just faved post #{notif.status.content}"
+}
+
+interacter.on_boost { |bot, notif|
+  puts "#{notif.account.acct} just boosted post #{notif.status.content}"
+}
+
+interacter.run

data/examples/periodic.rb

@@ -0,0 +1,7 @@
+require 'elephrame'
+
+periodic = Elephrame::Bots::Periodic.new '10s'
+
+periodic.run do |bot|
+  bot.post('testing', visibility: 'direct')
+end

data/examples/reply.rb

@@ -0,0 +1,8 @@
+require 'elephrame'
+
+replier = Elephrame::Bots::Reply.new
+
+replier.run { |bot, mention|
+  bot.post("@#{mention.account.acct} hey!", reply_id: mention.id,
+           visibility: mention.visibility)
+}

data/lib/elephrame/bot.rb

@@ -0,0 +1,35 @@
+module Elephrame  
+  module Bots
+    
+    # a superclass for other bots
+    # holds common functions and the rest api client
+    class BaseBot
+      attr_reader :client
+
+      def initialize
+        @client = Mastodon::REST::Client.new(base_url: ENV['INSTANCE'],
+                                             bearer_token: ENV['TOKEN'])
+      end
+      
+      def post(text, visibility: 'unlisted', spoiler: '', reply_id: '', media: [])
+        
+        if not media.empty?
+          media.collect! {|m|
+            @client.upload_media(m).id
+          }
+        end
+        
+        options = {
+          visibility: visibility,
+          spoiler_text: spoiler,
+          in_reply_to_id: reply_id,
+          media_ids: media,
+        }
+        
+        @client.create_status text, options
+      end
+    end
+
+  end
+end
+

data/lib/elephrame/mix/bots.rb

@@ -0,0 +1,26 @@
+require_relative '../rest/rest'
+require_relative '../streaming/streaming'
+require_relative '../bot'
+
+module Elephrame
+  module Bots
+    # a bot that posts things on an interval
+    # but can also respond to interactions
+    class PeriodInteract < BaseBot
+      include Elephrame::Scheduler
+      include Elephrame::AllInteractions
+      
+      def initialize intv
+        super()
+        
+        setup_scheduler intv
+        setup_streaming
+      end
+      
+      def run
+        run_scheduled &Proc.new
+        run_interact
+      end
+    end
+  end
+end

data/lib/elephrame/rest/bots.rb

@@ -0,0 +1,18 @@
+require_relative 'rest'
+require_relative '../bot'
+
+module Elephrame
+  module Bots
+    # a bot that runs commands based off of
+    # an interval or a cron string
+    class Periodic < BaseBot
+      include Elephrame::Scheduler
+      
+      def initialize intv
+        super()
+        
+        setup_scheduler intv
+      end
+    end
+  end
+end

data/lib/elephrame/rest/rest.rb

@@ -0,0 +1,24 @@
+module Elephrame
+  module Scheduler
+    attr :scheduler, :interval
+    attr_reader :schedule
+    
+    def setup_scheduler intv
+      require 'rufus-scheduler'
+      
+      
+      @interval = intv
+      @scheduler = Rufus::Scheduler.new
+    end
+    
+    def run_scheduled
+      @scheduler.repeat @interval do |j|
+        @schedule = j
+        yield(self)
+      end
+      @scheduler.join unless not @streamer.nil?
+    end
+
+    alias_method :run, :run_scheduled
+  end
+end

data/lib/elephrame/streaming/bots.rb

@@ -0,0 +1,34 @@
+require_relative 'streaming'
+require_relative '../bot'
+
+module Elephrame
+  module Bots
+    
+    # a bot that can respond to all interactions
+    class Interact < BaseBot
+      include Elephrame::Streaming
+      include Elephrame::AllInteractions
+      
+      def initialize
+        super()
+        
+        setup_streaming
+      end
+    end
+
+    # a bot that only replies when mentioned
+    # run accepts a block, but also supports
+    # use of on_reply
+    class Reply < BaseBot
+      include Elephrame::Streaming
+      include Elephrame::Reply
+
+      def initialize
+        super()
+        
+        setup_streaming
+      end
+    end
+
+  end
+end

data/lib/elephrame/streaming/streaming.rb

@@ -0,0 +1,75 @@
+module Elephrame
+  module Streaming
+    attr :streamer
+
+    def setup_streaming
+      @streamer = Mastodon::Streaming::Client.new(base_url: ENV['INSTANCE'],
+                                                  bearer_token: ENV['TOKEN'])
+    end
+  end
+    
+  module Reply
+    attr :on_reply
+
+    def on_reply &block
+      @on_reply = block
+    end
+
+    def run_reply
+      @streamer.user do |update|
+        next unless update.kind_of? Mastodon::Notification and update.type == 'mention'
+
+        if block_given?
+          yield(self, update.status)
+        else
+          @on_reply.call(self, update.status)
+        end
+      end
+    end
+
+    alias_method :run, :run_reply
+  end
+  
+  module AllInteractions
+    include Elephrame::Reply
+    attr :on_fave, :on_boost, :on_follow
+    
+    def on_fave &block
+      @on_fave = block
+    end
+    
+    def on_boost &block
+      @on_boost = block
+    end
+    
+    def on_follow &block
+      @on_follow = block
+    end
+    
+    def run_interact
+      @streamer.user do |update|
+        if update.kind_of? Mastodon::Notification
+          
+          case update.type
+              
+          when 'mention'
+            @on_reply.call(self, update.status) unless @on_reply.nil?
+            
+          when 'reblog'
+            @on_boost.call(self, update) unless @on_boost.nil?
+            
+          when 'favourite'
+            @on_fave.call(self, update) unless @on_fave.nil?
+            
+          when 'follow'
+            @on_follow.call(self, update) unless @on_follow.nil?
+            
+          end
+        end
+      end
+    end
+
+    
+    alias_method :run, :run_interact
+  end
+end

data/lib/elephrame/version.rb

@@ -0,0 +1,3 @@
+module Elephrame
+  VERSION = "0.2.0"
+end

data/lib/elephrame.rb

@@ -0,0 +1,5 @@
+require 'moostodon'
+require_relative  'elephrame/version'
+require_relative 'elephrame/streaming/bots'
+require_relative 'elephrame/rest/bots'
+require_relative 'elephrame/mix/bots'

metadata

@@ -0,0 +1,140 @@
+--- !ruby/object:Gem::Specification
+name: elephrame
+version: !ruby/object:Gem::Version
+  version: 0.2.0
+platform: ruby
+authors:
+- Zac
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2018-11-29 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.17'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.17'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+- !ruby/object:Gem::Dependency
+  name: rufus-scheduler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: moostodon
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.2.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.2.0
+description: 
+email:
+- thezacattacks@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- Gemfile.lock
+- LICENSE
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- elephrame.gemspec
+- examples/combined.rb
+- examples/interact.rb
+- examples/periodic.rb
+- examples/reply.rb
+- lib/elephrame.rb
+- lib/elephrame/bot.rb
+- lib/elephrame/mix/bots.rb
+- lib/elephrame/rest/bots.rb
+- lib/elephrame/rest/rest.rb
+- lib/elephrame/streaming/bots.rb
+- lib/elephrame/streaming/streaming.rb
+- lib/elephrame/version.rb
+homepage: https://github.com/theZacAttacks/elephrame
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+  homepage_uri: https://github.com/theZacAttacks/elephrame
+  source_code_uri: https://github.com/theZacAttacks/elephrame
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.7.6
+signing_key: 
+specification_version: 4
+summary: A framework for assisting in making mastodon/pleroma bots
+test_files: []