rubyhexagon 0.4.3 → 1.0.0

data/lib/rubyhexagon/type.rb

@@ -0,0 +1,70 @@
+# Copyright 2014-2018 Maxine Michalski <maxine@furfind.net>
+#
+# This file is part of rubyhexagon.
+#
+# rubyhexagon 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.
+#
+# rubyhexagon 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 rubyhexagon.  If not, see <http://www.gnu.org/licenses/>.
+
+module E621
+  # Class to hold type information.
+  #
+  # @api private
+  # @author Maxine Michalski
+  # @since 1.0.0
+  class Type
+    # @return [Integer] id of type
+    attr_reader :id
+
+    # @return [String] name of type
+    attr_reader :name
+
+    # @author Maxine Michalski
+    #
+    # Initializer for Type.
+    #
+    # @raise ArgumentError if type ID is not valid
+    #
+    # @param type [Hash] type data, fetched from e621
+    # @option type [Integer] :id Type ID (can be one of 0, 1, 3, 4 or 5
+    # @option type [
+    #
+    # @return the object
+    def initialize(id, locked)
+      unless [0, 1, 3, 4, 5].include?(id)
+        raise ArgumentError, "Unkown type id: #{id}"
+      end
+      @id     = id.to_i
+      @name   = [:general, :artist, nil, :copyright, :character, :species][@id]
+      @locked = locked ? true : false
+    end
+
+    # @author Maxine Michalski
+    #
+    # Comparison method for Types, to give a more meaningful comparison.
+    #
+    # @return [TrueClass, FalseClass]
+    def ==(other)
+      other.is_a?(Type) && @id == other.id && @name == other.name &&
+        @locked == other.locked?
+    end
+
+    # @author Maxine Michalski
+    #
+    # Check if this type is locked for the tag who has it assigned.
+    #
+    # @return [TrueClass] tag type is locked
+    # @return [FalseClass] tag type is not locked
+    def locked?
+      @locked
+    end
+  end
+end

data/lib/rubyhexagon/user.rb

@@ -0,0 +1,78 @@
+# Copyright 2014-2018 Maxine Michalski <maxine@furfind.net>
+#
+# This file is part of rubyhexagon.
+#
+# rubyhexagon 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.
+#
+# rubyhexagon 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 rubyhexagon.  If not, see <http://www.gnu.org/licenses/>.
+
+require 'time'
+
+module E621
+  # Class to hold user information for users on e621.
+  #
+  # @author Maxine Michalski
+  # @since 1.0.0
+  class User
+    # @return [Integer] id of user
+    attr_reader :id
+
+    # @return [String] name of user
+    attr_reader :name
+
+    # @return [Level] level of access, this user holds
+    attr_reader :level
+
+    # @return [Time] registration time of this user
+    attr_reader :created_at
+
+    # @author Maxine Michalski
+    #
+    # Initializer for User.
+    #
+    # @param user [Hash] user data, fetched from e621
+    #
+    # @return the object
+    def initialize(user)
+      @id = user[:id].to_i
+      @name = user[:name]
+    end
+
+    # @author Maxine Michalski
+    #
+    # Fill this object with user data.
+    def show!
+      user = API.new.fetch('user', 'show', id: @id)
+      @level      = Level.new(user[:level].to_i)
+      @created_at = Time.parse(user[:created_at])
+    end
+
+    # @author Maxine Michalski
+    #
+    # Returns a filled User object
+    #
+    # @return [User] filled out user object
+    def show
+      user = User.new(id: @id, name: @name)
+      user.show!
+      user
+    end
+
+    # @author Maxine Michalski
+    #
+    # Comparison method for User objects
+    #
+    # @return [TrueClass, FalseClass]
+    def ==(other)
+      other.is_a?(User) && @id == other.id && @name == other.name
+    end
+  end
+end

metadata

@@ -1,34 +1,47 @@
 --- !ruby/object:Gem::Specification
 name: rubyhexagon
 version: !ruby/object:Gem::Version
-  version: 0.4.3
+  version: 1.0.0
 platform: ruby
 authors:
-- Maxine Red
+- Maxine Michalski
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-06-26 00:00:00.000000000 Z
-dependencies: []
-description: Rubyhexagon provides Ruby bindings for the e621 [dot] net API.
+date: 2018-03-25 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: Rubyhexagon provides Ruby bindings for the e621 API.
 email: maxine@furfind.net
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- lib/api.rb
-- lib/container.rb
-- lib/pool.rb
-- lib/post.rb
 - lib/rubyhexagon.rb
-- lib/search.rb
-- lib/set.rb
-- lib/standard/error.rb
-- lib/standard/hash.rb
-- lib/standard/http.rb
-- lib/standard/int.rb
-- lib/standard/string.rb
-- lib/standard/time.rb
+- lib/rubyhexagon/artist.rb
+- lib/rubyhexagon/error.rb
+- lib/rubyhexagon/helper/api.rb
+- lib/rubyhexagon/image.rb
+- lib/rubyhexagon/level.rb
+- lib/rubyhexagon/post.rb
+- lib/rubyhexagon/search/posts.rb
+- lib/rubyhexagon/search/tags.rb
+- lib/rubyhexagon/tag.rb
+- lib/rubyhexagon/type.rb
+- lib/rubyhexagon/user.rb
 homepage: https://github.com/maxine-red/rubyhexagon
 licenses:
 - GPL-3.0
@@ -39,9 +52,9 @@ require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - "~>"
     - !ruby/object:Gem::Version
-      version: 1.9.2
+      version: '2.1'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
@@ -49,8 +62,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.2.2
+rubygems_version: 2.7.6
 signing_key: 
 specification_version: 4
-summary: Rubyhexagon, Ruby bindings for e621[dot]net.
+summary: Rubyhexagon, Ruby bindings for e621.
 test_files: []

data/lib/api.rb

@@ -1,79 +0,0 @@
-=begin
-  Copyright 2014, 2015, 2017 Maxine Michalski <maxine@furfind.net>
-
-  This file is part of rubyhexagon.
-
-  rubyhexagon 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.
-
-  rubyhexagon 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 rubyhexagon.  If not, see <http://www.gnu.org/licenses/>.
-=end
-
-require "standard/http"
-
-module E621
-  class API
-    def initialize(user=nil,pass=nil)
-      @http   = HTTP.new
-      login(user,pass) if !defined? @@login
-    end
-    # A wrapper function to fit into the general theme better.
-    def post_list(*args)
-      post_index(*args)
-    end
-    # Send commands to API and parse all answers, even errors.
-    # Also make it work with POST and GET requests.
-    def method_missing(method,*args)
-      request = request2body(args.first)
-      method = method.to_s.split("_")
-      m = case method[0]
-          when "post" then
-            case method[1]
-            when "show" then :get
-            else :post
-            end
-          else :post
-          end
-      @http.__send__(m,"/#{method.join("/")}.json",request)
-    end
-    private
-    # This helper function provides the functionality of translating Ruby Hashes
-    # into HTTP POST body strings.
-    def request2body(request)
-      query = @@login ? "#@@login&" : String.new
-      request = request.map do |k,v|
-        if v.is_a?(Hash) then
-          raise Argumenterror, "Hashes as request values aren't allowed."
-        elsif v.is_a?(Array) then
-          v = v.join(",")
-        end
-        "#{k}=#{v}"
-      end
-      query += request.join("&")
-      return query
-    end
-    # Perform an API and site login. This function needs to be called once
-    # before any actual API call can be made.
-    def login(user,pass)
-      if user == nil && pass == nil then
-        @@login = nil
-      else
-        request = {name:name,password:pass}
-        body = @http.get("/user/login.json",request)
-        if body.has_key?("success") && (!body["success"] || body["success"] == "failed") then
-          raise AuthentificationError, "Username or password wrong!"
-        else
-          @@login = "login=#{body["name"]}&password_hash=#{body["password_hash"]}"
-        end
-      end
-    end
-  end
-end

data/lib/container.rb

@@ -1,45 +0,0 @@
-=begin
-  Copyright 2014, 2015, 2017 Maxine Michalski <maxine@furfind.net>
-
-  This file is part of rubyhexagon.
-
-  rubyhexagon 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.
-
-  rubyhexagon 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 rubyhexagon.  If not, see <http://www.gnu.org/licenses/>.
-=end
-
-module E621
-  class Container
-    def method_missing(method)
-      if instance_variables.include?("@#{method}".to_sym) && method != :api then
-        return instance_variable_get("@#{method}")
-      else
-        raise NoMethodError, "undefined method #{method} for #{self.class}"
-      end
-    end
-    private
-    def set_variables(container)
-      container.each do |k,v|
-        if (k == "created_at" || k == "updated_at") && v.is_a?(Hash) then
-          v = Time.at(v["s"])
-        elsif (k == "created_at" || k == "updated_at") && !v.is_a?(Hash) then
-          v = Time.at(v)
-        elsif k == "cached_tags" then
-          k = "tags"
-        elsif k == "posts" then
-          v.map!{|post|Post.new(post)}
-        end
-        instance_variable_set("@#{k}",v)
-      end
-    end
-  end
-end

data/lib/pool.rb

@@ -1,71 +0,0 @@
-=begin
-  Copyright 2014, 2015, 2017 Maxine Michalski <maxine@furfind.net>
-
-  This file is part of rubyhexagon.
-
-  rubyhexagon 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.
-
-  rubyhexagon 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 rubyhexagon.  If not, see <http://www.gnu.org/licenses/>.
-=end
-
-require "digest/md5"
-
-module E621
-  class Pool < Container
-    def initialize(post)
-      @api = API.new("pool")
-      if post.is_a?(Hash) then
-        set_variables(post)
-      elsif post.is_a?(Fixnum) then
-        set_variables(@api.get("show",{"id"=>post}))
-      else
-        raise ArgumentError, "Parameter must be Hash or Number."
-      end
-    end
-
-    def keys
-      return instance_variables.map{|i|i.to_s.sub("@","")}
-    end
-   
-    def updated_at=(time)
-      @updated_at = time
-    end
-
-    def name=(name)
-      @name = name
-    end
-    
-    def posts=(posts)
-      @posts = posts
-    end
-
-    def to_json(n=nil)
-      json_hash = Hash.new
-      instance_variables.each do |i|
-        v = instance_variable_get(i)
-        v = v.is_a?(Time) ? v.to_i : v
-        json_hash.store(i.to_s.sub("@",""),v)
-      end
-      return json_hash.to_json
-    end
-
-    def each_post
-      (@post_count/24.0).ceil.times do |page|
-        @posts.each do |post|
-          yield post
-        end
-        post = api.get("show",{"id"=>@id,"page"=>page+2})
-        set_variables(post)
-      end
-    end
-  end
-end

data/lib/post.rb

@@ -1,50 +0,0 @@
-=begin
-  Copyright 2014, 2015, 2017 Maxine Michalski <maxine@furfind.net>
-
-  This file is part of rubyhexagon.
-
-  rubyhexagon 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.
-
-  rubyhexagon 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 rubyhexagon.  If not, see <http://www.gnu.org/licenses/>.
-=end
-
-require "digest/md5"
-
-module E621
-  class Post < Container
-    def initialize(post)
-      @api = API.new
-      if post.is_a?(Fixnum) || (post.is_a?(String) && post.match(/^[0-9,a-f]+$/i)) then
-        post = if post.is_a?(String) && post.length == 32 then {md5:post}
-               elsif post.is_a?(Fixnum) || (post.is_a?(String) && post.match(/^\d+$/)) then
-                 {id:post.to_i}
-               else
-                 raise ArgumentError, "Neither an ID nor a MD5 Hash."
-               end
-        post = @api.post_show(post)
-      elsif post.is_a?(Hash) then # Variable post is ready to use. Do nothing.
-      else
-        raise ArgumentError, "Post only accepts an id, a MD5 hashsum or a Ruby hash."
-      end
-      set_variables(post)
-    end
-    alias show initialize
-    # Cast a vote! Any value above 0 votes up, every value below 0 votes down.
-    # Zero itself causes an error.
-    def vote(direction)
-      if    direction > 0 then @api.post_vote(1)
-      elsif direction < 0 then @api.post_vote(-1)
-      else raise ArgumentError, "Zero isn't allowed for voting results."
-      end
-    end
-  end
-end