weasyl-ruby 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 4a1d6133b4d7d2241406cf52b4a8bdf5661b6ec3
+  data.tar.gz: 2ac8ef501b4271827d0ae8f0aeeed3fe1d0c375f
+SHA512:
+  metadata.gz: 7cd7647771291b304b3e1b40c748224e8f2651e06f9fa165a96d7a77a96a2f1b03edc7d20efe2eb9c71e3302483914933f3526a8755a6b6b71ca986bd21c887b
+  data.tar.gz: 598cb59ae9f73dd7f65431e5ff90d7381e57548bfda4060dfedf5836b6cae6f8346aaa62bd48dae21268a1820bb51ae6402302879d244d0a788a48c00605065f

data/lib/weasyl.rb

@@ -0,0 +1,39 @@
+# frozen_string_literal: true
+
+# Copyright 2018 Maxine Michalski <maxine@furfind.net>
+#
+# This file is part of Weasyl.
+#
+# Weasyl is free software: you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+#
+# Weasyl is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with Weasyl.  If not, see <http://www.gnu.org/licenses/>.
+
+require 'open-uri'
+require 'uri'
+require 'json'
+
+require_relative 'weasyl/api'
+require_relative 'weasyl/messages'
+require_relative 'weasyl/submission'
+
+# Namespace for all classes in this gem.
+# @author Maxine Michalski
+# @since 0.1.0
+module Weasyl
+  MAJOR = 0
+  MINOR = 1
+  PATCH = 0
+  NAME = 'weasyl-ruby'
+  AUTHOR = '~maxinered'
+  VERSION = "#{MAJOR}.#{MINOR}.#{PATCH}"
+  USER_AGENT = "#{Weasyl::NAME}/#{Weasyl::VERSION} by #{Weasyl::AUTHOR}"
+end

data/lib/weasyl/api.rb

@@ -0,0 +1,59 @@
+# frozen_string_literal: true
+
+# Copyright 2018 Maxine Michalski <maxine@furfind.net>
+#
+# This file is part of Weasyl.
+#
+# Weasyl is free software: you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+#
+# Weasyl is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with Weasyl.  If not, see <http://www.gnu.org/licenses/>.
+
+require 'singleton'
+module Weasyl
+  # @author Maxine Michalski
+  # Helper class to abstract actual API communication
+  # @since 0.1.0
+  class API
+    include Singleton
+    # Sets the API key. OAuth isn't supported yet.
+    # @notice This method is not supposed to be used directly!
+    # @return [String] API key for weasyl API
+    attr_accessor :key
+    def fetch(endpoint, params = {})
+      params = if params.empty?
+                 ''
+               else
+                 "?#{params.to_a.map { |a| a.join('=') }.join('&')}"
+               end
+      raise ArgumentError, 'API key can\'t be empty' if @key.nil?
+      JSON.parse(URI.parse("https://weasyl.com/api/#{endpoint}#{params}")
+        .read('X-Weasyl-API-Key' => @key, 'User-Agent' => Weasyl::USER_AGENT),
+                 symbolize_names: true)
+    end
+
+    # A test method to test API connection
+    # @author Maxine Michalski
+    # @return [Hash] A Hash object with user information
+    # @since 0.1.0
+    def whoami
+      fetch(:whoami)
+    end
+
+    # Display version of weasyl API we connected to
+    # @author Maxine Michalski
+    # @since 0.1.0
+    # @return [String] String that shows current weasyl API version
+    def version
+      fetch(:version)[:short_sha]
+    end
+  end
+end

data/lib/weasyl/media.rb

@@ -0,0 +1,157 @@
+# frozen_string_literal: true
+
+# Copyright 2018 Maxine Michalski <maxine@furfind.net>
+#
+# This file is part of Weasyl.
+#
+# Weasyl is free software: you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+#
+# Weasyl is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with Weasyl.  If not, see <http://www.gnu.org/licenses/>.
+
+module Weasyl
+  # Container for media information
+  # @author Maxine Michalski
+  # @since 0.1.0
+  class Media
+    # @return [Array<Weasyl::Thumbnail>] List of thumbnails attached to this
+    # media item
+    attr_reader :thumbnails
+
+    # @return [Array<Weasyl::Thumbnail>] List of cover images attached to this
+    # media item
+    attr_reader :covers
+
+    # @return [Array<Weasyl::Thumbnail>] List of media files attached to this
+    # media item
+    attr_reader :media_files
+
+    # Initializer for a Media object
+    # @author Maxine Michalski
+    # @since 0.1.0
+    # @notice Special thumbnail objects are not supported at this point
+    # @return object
+    def initialize(media)
+      @thumbnails = media[:thumbnail].map { |m| Weasyl::Thumbnail.new(m) }
+      unless media[:cover].nil?
+        @covers = media[:cover].map { |m| Weasyl::Cover.new(m) }
+      end
+      return if media[:submission].nil?
+      @media_files = media[:submission].map { |m| Weasyl::MediaFile.new(m) }
+    end
+
+    # Test for the presence of covers
+    # @author Maxine Michalski
+    # @since 0.1.0
+    # @return [Boolean]
+    def covers?
+      !@covers.nil?
+    end
+
+    # Test for the presence of media files
+    # @author Maxine Michalski
+    # @since 0.1.0
+    # @return [Boolean]
+    def media_files?
+      !@media_files.nil?
+    end
+  end
+
+  # Base class for media items
+  # @author Maxine Michalski
+  # @since 0.1.0
+  class MediaItem
+    # @return [Integer] Media ID of this item
+    # @notice Can be nil
+    attr_reader :id
+
+    # @return [URI] Media URL to thumbnail
+    attr_reader :url
+
+    # @return [Array<Weasyl::Link>] Links to other media
+    # @notice This attribute can be nil
+    attr_reader :links
+
+    # Shared initializer for all Media items
+    # @author Maxine Michalski
+    # @since 0.1.0
+    def initialize(item)
+      @id = item[:mediaid]
+      @url = URI.parse(item[:url])
+      return if item[:links].nil?
+      @links = item[:links].map do |k, v|
+        Weasyl::Link.new(k, v)
+      end
+    end
+
+    # Indicator of if this MediaItem has an ID or not
+    # @author Maxine Michalski
+    # @since 0.1.0
+    # @return [Boolean]
+    def id?
+      !@id.nil?
+    end
+
+    # Indicator of if this MediaItem object has links or not
+    # @author Maxine Michalski
+    # @since 0.1.0
+    # @return [Boolean]
+    def links?
+      !@links.nil?
+    end
+  end
+
+  # Container for Thumbnail information
+  # @author Maxine Michalski
+  # @since 0.1.0
+  class Thumbnail < MediaItem
+  end
+
+  # Container for cover images
+  # @author Maxine Michalski
+  # @since 0.1.0
+  class Cover < MediaItem
+  end
+
+  # Container for Submission media info (the actual file)
+  # @author Maxine Michalski
+  # @since 0.1.0
+  class MediaFile < MediaItem
+  end
+
+  # A relationship between MediaItems
+  # @author Maxine Michalski
+  # @since 0.1.0
+  class Link
+    # @return [Symbol] Type of item this link links
+    attr_reader :type
+
+    # @return [Array<Weasyl::MediaItem>] Items that are linked to
+    attr_reader :links
+
+    # Initializer for link object
+    # @author Maxine Michalski
+    # @since 0.1.0
+    # @return object
+    def initialize(type, link)
+      case @type = type
+      when :cover
+        @links = link.map { |l| Weasyl::Cover.new(l) }
+      when :thumbnail
+        @links = link.map { |l| Weasyl::Thumbnail.new(l) }
+      when :submission
+        @links = link.map { |l| Weasyl::MediaFile.new(l) }
+      else
+        raise ArgumentError, "Unknown type: #{@type}"
+      end
+    end
+  end
+end

data/lib/weasyl/messages.rb

@@ -0,0 +1,97 @@
+# frozen_string_literal: true
+
+# Copyright 2018 Maxine Michalski <maxine@furfind.net>
+#
+# This file is part of Weasyl.
+#
+# Weasyl is free software: you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+#
+# Weasyl is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with Weasyl.  If not, see <http://www.gnu.org/licenses/>.
+
+module Weasyl
+  # Helper module to fetch information about messages.
+  # @author Maxine Michalski
+  # @since 0.1.0
+  module Messages
+    # Fetch a summary of new message counts
+    # @author Maxine Michalski
+    # @since 0.1.0
+    # @return [Weasyl::Messages::Summary]
+    def self.summary
+      Weasyl::Messages::Summary.new(Weasyl::API.instance
+        .fetch('messages/summary'))
+    end
+
+    # Fetch a list of submissions for the currently logged in user
+    # @author Maxine Michalski
+    # @since 0.1.0
+    # @param count [Integer] max amount of submissions returned (100)
+    # @param backtime [Integer] UNIX EPOCH, only submissions after this time are
+    # returned
+    # @param nexttime [Integer] UNIX EPOCH, only submissions before this time
+    # are returned
+    # @notice This method accepts a block, that goes through all available
+    # submissions. While the non-block version only returns 100 submissions at
+    # all.
+    # @return [Weasyl::SubmissionList]
+    def self.submissions(count = 100, backtime = 0, nexttime = Time.now.to_i)
+      params = { count: count, backtime: backtime, nexttime: nexttime }
+      subs = nil
+      loop do
+        subs = fetch_subs(params)
+        break if subs[:nexttime].nil? || !block_given?
+        subs[:submissions].each { |s| yield s }
+        params[:nexttime] = subs[:nexttime]
+      end
+      subs
+    end
+
+    def self.fetch_subs(params)
+      subs = Weasyl::API.instance.fetch('messages/submissions', params)
+      subs[:submissions].map! do |s|
+        Weasyl::Submission.new(s)
+      end
+      subs
+    end
+    private_class_method :fetch_subs
+
+    # Class that represents a summary of message information.
+    # @author Maxine Michalski
+    # @since 0.1.0
+    class Summary
+      # @return [Integer] Count of unread comments
+      attr_reader :comments
+
+      # @return [Integer] Count of unread journals
+      attr_reader :journals
+
+      # @return [Integer] Count of unread notifications
+      attr_reader :notifications
+
+      # @return [Integer] Count of unseen submissions
+      attr_reader :submissions
+
+      # @return [Integer] Count of unread notes
+      attr_reader :unread_notes
+
+      # Initializer for Message summaries
+      # @author Maxine Michalski
+      # @since 0.1.0
+      # @return object
+      def initialize(sum)
+        sum.each do |k, v|
+          instance_variable_set("@#{k}".to_sym, v)
+        end
+      end
+    end
+  end
+end

data/lib/weasyl/submission.rb

@@ -0,0 +1,87 @@
+# frozen_string_literal: true
+
+# Copyright 2018 Maxine Michalski <maxine@furfind.net>
+#
+# This file is part of Weasyl.
+#
+# Weasyl is free software: you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+#
+# Weasyl is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with Weasyl.  If not, see <http://www.gnu.org/licenses/>.
+
+require 'time'
+require_relative 'media'
+
+module Weasyl
+  # Container for submission information
+  # @author Maxine Michalski
+  # @since 0.1.0
+  class Submission
+    # @return [String] Owner of submission
+    attr_reader :owner
+
+    # @return [String] Owner of submission
+    attr_reader :owner_login
+
+    # @return [Time] Timestamp when submission was uploaded
+    attr_reader :posted_at
+
+    # @return [String] Rating marker
+    attr_reader :rating
+
+    # @return [Integer] Submission id
+    attr_reader :id
+
+    # @return [String] Submission sub-type
+    attr_reader :subtype
+
+    # @return [Array<String>] Tags associated with this submission
+    attr_reader :tags
+
+    # @return [String] Title of submission
+    attr_reader :title
+
+    # @return [String] Type of submission
+    attr_reader :type
+
+    # @return [URI] Link to submision
+    attr_reader :link
+
+    # @return [Weasyl::Media] Media object for current submission
+    attr_reader :media
+
+    # Initializer for Submission containers
+    # @author Maxine Michalski
+    # @since 0.1.0
+    # @return object
+    def initialize(sub)
+      sub.select! do |k, _|
+        %i[rating tags link owner owner_login submitid title media posted_at
+           subtype type].include?(k)
+      end
+      sub_prepared(sub).each do |k, v|
+        instance_variable_set("@#{k}".to_sym, v)
+      end
+    end
+
+    private
+
+    def sub_prepared(sub)
+      sub.map do |k, v|
+        v = Time.parse(v) if k == :posted_at
+        v = URI.parse(v) if k == :link
+        v = Weasyl::Media.new(v) if k == :media
+        k = :id if k == :submitid
+        [k, v]
+      end
+    end
+  end
+end

metadata

@@ -0,0 +1,62 @@
+--- !ruby/object:Gem::Specification
+name: weasyl-ruby
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Maxine Michalski
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2018-10-31 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: json
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+description: Ruby bindings for the weasyl art board
+email: maxine@furfind.net
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/weasyl.rb
+- lib/weasyl/api.rb
+- lib/weasyl/media.rb
+- lib/weasyl/messages.rb
+- lib/weasyl/submission.rb
+homepage: https://github.com/maxine-red/weasyl
+licenses:
+- GPL-3.0
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - "~>"
+    - !ruby/object:Gem::Version
+      version: '2.3'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.5.2.1
+signing_key: 
+specification_version: 4
+summary: Ruby bindings for weasyl
+test_files: []