rubyhexagon 0.0.1

data/lib/api.rb

@@ -0,0 +1,123 @@
+=begin
+  Copyright 2014 Maxine Red <maxine_red1@yahoo.com>
+
+  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
+  attr_reader :user
+  class API
+    # Variable mod is the module (Post, Pool, Set,...) this API is called for.
+    def initialize(mod=nil)
+      @http   = HTTP.new
+      @mod    = mod
+      @user   = user_login
+    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)
+      if [:get,:post].include?(method) then
+        action,request,cookie = args
+        r,tries = request2body(request,cookie),0
+        begin
+          json = @http.__send__(method,"/#@mod/#{action}.json",r)
+        rescue Timeout::Error
+          sleep 2**tries
+          tries += 1
+          #E621.log.debug("#@mod/#{action} failed: #{e.class}")
+          raise if tries >= 4
+          # if we see more than 4 timeout errors, then there
+          # is something wrong
+          retry
+        end
+        #raise APIError,json["reason"] if json.include?("success") && !json["success"]
+        return json
+      else
+        raise NoMethodError, "undefined method #{method} for #{self.class}"
+      end
+    end
+    private
+    # This helper function provides the functionality of translating Ruby Hashes
+    # into HTTP POST body strings.
+    def request2body(r,c)
+      s = String.new
+      r.each do |k,v|
+        s += "&" unless s == String.new
+        if v.is_a?(Hash) then
+          t = String.new
+          v.each do |e,a|
+            t += "&" unless t == String.new
+            t += "#{k}[#{e}]=#{a}"
+          end
+          s += t
+        else
+          s += "#{k}=#{v}"
+        end
+      end
+      s += "&#@@login" if !c
+      return s
+    end
+    # Perform an API and site login. This function needs to be called once
+    # before any actual API call can be made.
+    def user_login
+      # Cookie login gets eliminated for now.
+      name,pass = String.new, String.new
+      # Perform a re-login if the last time is older than x days. Or if there is
+      # no cookie.
+      passwd = File.expand_path(Config.paths["passwd"])
+      if File.exist?(passwd) then
+        File.open(passwd){|f|@passwd=f.read.parse}
+      else
+        @passwd = {"name"=>"","pass"=>"","last_login"=>0}
+      end
+      if (Time.now.to_i-@passwd["last_login"].to_i) < 3.days then
+        @@login = @passwd["login"]
+      else 
+        if @passwd["name"] != "" && @passwd["pass"] != "" then
+          name,pass = @passwd["name"],@passwd["pass"]
+        else
+          puts "No user data found. Please provide user data."
+          name,pass = get_credentials
+          @passwd["name"],@passwd["pass"] = name,pass
+          # Store that data for later use.
+        end
+        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"]}"
+          @passwd["login"] = @@login # Save login string for later use.
+        end
+        @passwd["last_login"] = Time.now.to_i
+        # Write everything back!
+        File.open(passwd,"w"){|f|f.print @passwd.to_json}
+      end
+      return @passwd["name"]
+    end
+    # If there is no data saved for login, ask the user. They must know!
+    def get_credentials
+      print "Username: "
+      name = $stdin.gets.chomp
+      print "Password: "
+      pass = `stty_o=$(stty -g);stty -echo;read pass;stty $stty_o; echo $pass`.chomp
+      puts
+      return [name,pass]
+    end
+  end
+end

data/lib/config.rb

@@ -0,0 +1,46 @@
+=begin
+  Copyright 2014 Maxine Red <maxine_red1@yahoo.com>
+
+  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 Config
+    def self.config
+      return @@config
+    end
+
+    def self.paths
+      return @@paths
+    end
+
+    def self.blacklist
+      return @@blacklist
+    end
+
+    def self.config=(config)
+      if File.exist?(config) then
+        File.open(config) do |f|
+          c = f.read.parse
+          @@paths     = c.delete("paths")
+          @@blacklist = c.delete("blacklist")
+          @@config    = c
+        end
+      else
+        raise ArgumentError, "No configuration file specified. Broken installation!"
+      end
+    end
+  end
+end

data/lib/container.rb

@@ -0,0 +1,43 @@
+=begin
+  Copyright 2014 Maxine Red <maxine_red1@yahoo.com>
+
+  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) 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"
+        end
+        instance_variable_set("@#{k}",v)
+      end
+    end
+  end
+end

data/lib/pool.rb

@@ -0,0 +1,50 @@
+=begin
+  Copyright 2014 Maxine Red <maxine_red1@yahoo.com>
+
+  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)
+      set_variables(post)
+    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 to_json
+      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
+  end
+end

data/lib/post.rb

@@ -0,0 +1,106 @@
+=begin
+  Copyright 2014 Maxine Red <maxine_red1@yahoo.com>
+
+  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)
+      set_variables(post)
+    end
+
+    def download_data
+      host,port = @file_url.sub(%r{^.+?//},"").sub(%r{/.+$},""),@file_url.match(/^https/) ? 443 : 80
+      http = HTTP.new(host,port)
+      body = String.new
+      while Digest::MD5.hexdigest(body) != @md5 do
+        body = http.get(@file_url.sub(/^.+?\.net/,""),"")["body"]
+      end
+      return body
+    end
+
+    def download(where)
+      host,port = @file_url.sub(%r{^.+?//},"").sub(%r{/.+$},""),@file_url.match(/^https/) ? 443 : 80
+      http = HTTP.new(host,port)
+      if !File.exist?(where) then
+        body = ""
+        while Digest::MD5.hexdigest(body) != @md5 do
+          body = http.get(@file_url.sub(/^.+?\.net/,""),"")["body"]
+        end
+        File.open(where,"w") do |f|
+          f.print body
+        end
+      else
+        md5 = String.new
+        File.open(where,"r") do |f|
+          md5 = Digest::MD5.hexdigest(f.read)
+        end
+        if md5 != @md5 then
+          body = ""
+          while Digest::MD5.hexdigest(body) != @md5 do
+            body = http.get(@file_url.sub(/^.+?\.net/,""),"")["body"]
+          end
+          File.open(where,"w") do |f|
+            f.print body
+          end
+        end
+      end
+    end
+
+    def add_to_set(id)
+      api = API.new("set")
+      api.post("add_post",{"post_id"=>@id,"set_id"=>id})
+    end
+
+    def remove_from_set(id)
+      api = API.new("set")
+      api.post("remove_post",{"post_id"=>@id,"set_id"=>id})
+    end
+
+    def favorite
+      api = API.new("favorite")
+      api.post("create",{"id"=>@id})
+    end
+
+    def unfavorite
+      api = API.new("favorite")
+      api.post("destroy",{"id"=>@id})
+    end
+
+    def vote(dir)
+      dir = if dir >= 0 then 1 elsif dir < 0 then -1 end
+      api = API.new("post")
+      api.post("vote",{"id"=>@id,"score"=>dir})
+    end
+
+    def keys
+      return instance_variables.map{|i|i.to_s.sub("@","")}
+    end
+    
+    def to_json(b=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
+  end
+end

data/lib/rubyhexagon.rb

@@ -0,0 +1,34 @@
+=begin
+  Copyright 2014 Maxine Red <maxine_red1@yahoo.com>
+
+  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/string"
+require "standard/int"
+require "standard/error"
+require "standard/time"
+
+require "api"
+require "config"
+require "container"
+require "search"
+require "pool"
+
+module E621
+  Name = "rubyhexagon"
+  Version = "0.0.1"
+end

data/lib/search.rb

@@ -0,0 +1,73 @@
+=begin
+  Copyright 2014 Maxine Red <maxine_red1@yahoo.com>
+
+  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 "post"
+
+module E621
+  attr_reader :posts
+  class Search
+    # commands update/download
+    def initialize(query)
+      @api,@mt      = API.new("post"),Mutex.new
+      @bad_tags     = /(\s|^)(#{Config.blacklist.map{|x|Regexp.escape(x)}.join("|")})(\s|$)/
+      @request = {"limit"=>100,"page"=>1,"tags"=>query.join("+")}
+      fetch
+    end
+
+    def next!
+      @request["page"] += 1
+      fetch
+    end
+
+    def each_post
+      while @posts != Array.new do
+        @posts.each do |post|
+          yield post
+        end
+        next!
+      end
+    end
+
+    def page
+      return @request["page"]
+    end
+
+    def page=(page)
+      @request["page"]=page
+      fetch
+    end
+
+    def previous!
+      @request["page"] -= 1
+      fetch
+    end
+
+    def to_json(a=nil,b=nil)
+      posts = @posts.map{|o|o.to_json}
+      {"name"=>@name,"queries"=>@queries,"posts"=>posts}.to_json
+    end
+    private
+    def fetch
+      @posts = @api.post("index",@request).map do |post|
+        #Post.new(post) unless post["tags"].match(@bad_tags) || post["score"] <= 30
+        Post.new(post) unless post["tags"].match(@bad_tags)
+      end.compact
+    end
+  end
+end

data/lib/set.rb

@@ -0,0 +1,43 @@
+=begin
+  Copyright 2014 Maxine Red <maxine_red1@yahoo.com>
+
+  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 Set < Container
+    def initialize(post)
+      set_variables(post)
+    end
+
+    def add_post(id)
+      api = API.new("set")
+      api.post("add_post",{"post_id"=>id,"set_id"=>@id})
+    end
+
+    def keys
+      return instance_variables.map{|i|i.to_s.sub("@","")}
+    end
+    
+    def to_json
+      json_hash = Hash.new
+      instance_variables.each do |i|
+        json_hash.store(i.to_s.sub("@",""),instance_variable_get(i))
+      end
+      return json_hash.to_json
+    end
+  end
+end

data/lib/standard/error.rb

@@ -0,0 +1,24 @@
+=begin
+  Copyright 2014 Maxine Red <maxine_red1@yahoo.com>
+
+  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
+  # This is just a set of classes to better differenciate between common errors.
+  class APIError < StandardError; end
+  class AuthentificationError < StandardError; end
+end

data/lib/standard/hash.rb

@@ -0,0 +1,29 @@
+=begin
+  Copyright 2014 Maxine Red <maxine_red1@yahoo.com>
+
+  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
+
+class Hash
+  def method_missing(m,args=nil)
+    m = m.to_s
+    if self.has_key?(m) then
+      return a[m]
+    else
+      raise NoMethodError, "undefined method #{m} for #{self.class}"
+    end
+  end
+end

data/lib/standard/http.rb

@@ -0,0 +1,83 @@
+=begin
+  Copyright 2014 Maxine Red <maxine_red1@yahoo.com>
+
+  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 "net/http"
+
+module E621
+  class HTTP
+    def initialize(host="e621.net",port=443)
+      @http = Net::HTTP.new(host,port)
+      @http.use_ssl = true if port == 443
+    end
+    # Small wrapper function for post calls. This way a proper logging is
+    # guaranteed.
+    def post(url,request)
+      return parse_body(@http.post(url,request))
+    end
+    # Small wrapper function for get calls. This way a proper logging is
+    # guaranteed.
+    def get(url,request)
+      return parse_body(@http.get("#{url}?#{request}"))
+    end
+    # #geti gives an immediate response in the form of bytes downloaded. This
+    # won't be included in the gems though.
+    def geti(url,request)
+      uri = "#{url}?#{request}"
+      count = (@http.head(uri)["content-length"].to_i/1024.0).round(1)
+      clength,message = count.to_s.length,String.new
+      @http.get("#{url}?#{request}") do |body|
+        message += body
+        mlength = (message.length/1024.0).round(1)
+        print "Downloaded #{" "*(clength-mlength.to_s.length)}#{mlength}/#{count}kB\r"
+      end
+      return {"body"=>message}
+    end
+    private
+    # As every body gets processed the same, just put it into a seperate method.
+    def parse_body(resp)
+      begin
+        if resp["content-type"].sub(/;.+/,"") == "application/json" then
+          body = resp.body.parse
+        else
+          {"body"=>resp.body}
+        end
+      rescue
+        body = errorcode(resp.code,url) # Emulate a proper API response!
+      end
+    end
+    # Parse all code that returns not in JSON to actual JSON like hashes.
+    def errorcode(code,url)
+      body = {"success"=>false,"reason"=>""}
+      body["reason"] =  if    code.match(/3\d{2}/)  then "We got redirected!"
+                        elsif code.match(/403/)     then "Access denied!"
+                        elsif code.match(/404/)     then "File not found!"
+                        elsif code.match(/420/)     then "Record could not be saved!"
+                        elsif code.match(/421/)     then "User it throttled, try again later!"
+                        elsif code.match(/422/)     then "The resource is locked!"
+                        elsif code.match(/423/)     then "Resource already exists!"
+                        elsif code.match(/4\d{2}/)  then "We made a bad request!"
+                        elsif code.match(/500/)     then "Internal server error!"
+                        elsif code.match(/503/)     then "Server has too much load!"
+                        elsif code.match(/5\d{2}/)  then "Some unkown server side error!"
+                        else "HTTP response code out of range!!"
+                        end
+      return body
+    end
+  end
+end