wykop 0.6

data/doc/user/link.md

@@ -0,0 +1,14 @@
+### Link
+
+```
+client.link_index( :param1 => 2248060 )
+client.link_dig( :param1 => 2248060 )
+client.link_cancel( :param1 => 2248060 )
+client.link_bury( :param1 => 2248060 )
+client.link_comments( :param1 => 2248060 )
+client.link_reports( :param1 => 2248060 )
+client.link_digs( :param1 => 2248060 )
+client.link_buryreasons
+client.link_observe( :param1 => 2248060 )
+client.link_favorite( :param1 => 2248060 )
+```

data/doc/user/pm.md

@@ -0,0 +1,13 @@
+### PM ( private messaging )
+
+ ```
+ client.messages_list
+
+ # Reads all messages from user 'ouna-'
+ client.messages_read(:param1 => 'ouna-')
+
+ # delete all messages from user 'ouna-'
+ client.messages_delete(:param1 => 'ouna-')
+
+ # send message 'test wykop gem' to user 'ouna-' with wykop.pl logo attached
+ client.message_send(:param1 => 'ouna-', :body => 'test wykop gem', :embed => 'http://wykop.pl/logo.png')

data/doc/user/rank.md

@@ -0,0 +1,12 @@
+### Rank
+
+Displays current rank on wykop.pl
+
+```
+# default: rank, incremental
+client.rank_show
+
+# other switches
+# comment_count, link_count, hp_link_count, followers_count
+client.rank_show({:order => 'followers_count'})
+```

data/lib/wykop.rb

@@ -0,0 +1,8 @@
+require 'wykop/version'
+require 'wykop/client'
+
+module Wykop
+  def self.client
+    @client ||= Wykop::Client.new
+  end
+end

data/lib/wykop/client.rb

@@ -0,0 +1,77 @@
+require 'wykop/configuration'
+require 'wykop/operations/user'
+require 'wykop/error'
+require 'awesome_print'
+require 'httparty'
+require 'json'
+
+require 'wykop/operations/request'
+
+require 'wykop/operations/add'
+require 'wykop/operations/top'
+require 'wykop/operations/tag'
+require 'wykop/operations/tags'
+require 'wykop/operations/rank'
+require 'wykop/operations/link'
+require 'wykop/operations/links'
+require 'wykop/operations/search'
+require 'wykop/operations/stream'
+require 'wykop/operations/popular'
+require 'wykop/operations/related'
+require 'wykop/operations/message'
+require 'wykop/operations/favorites'
+require 'wykop/operations/observatory'
+
+module Wykop
+  class Client
+    REQUEST_CLASSES = [Wykop::Operations::User, Wykop::Operations::Request, Wykop::Operations::Top,
+                       Wykop::Operations::Popular, Wykop::Operations::Links, Wykop::Operations::Rank,
+                       Wykop::Operations::Observatory, Wykop::Operations::Tags, Wykop::Operations::Stream,
+                       Wykop::Operations::Search, Wykop::Operations::Add, Wykop::Operations::Related,
+                       Wykop::Operations::Favorites, Wykop::Operations::Messages, Wykop::Operations::Link,
+                       Wykop::Operations::Tag]
+    attr_reader :configuration
+    attr_accessor :user_info
+    attr_accessor :request_data
+
+    def initialize(options = nil)
+      @configuration = nil
+      @user_info = nil
+      @request_data = nil
+      define_request_methods
+
+      unless options.nil?
+        @configuration = Configuration.new(options)
+        check_api_keys
+      end
+    end
+
+    def check_api_keys
+      if configuration.nil? || !configuration.valid?
+        @configuration = nil
+        raise Error::NoApiKeys
+      else
+        @configuration.freeze
+      end
+    end
+
+    def define_request_methods
+      REQUEST_CLASSES.each do |request_class|
+        operations_instance = request_class.new(self)
+        create_methods_from_instance(operations_instance)
+      end
+    end
+
+    def create_methods_from_instance(instance)
+      instance.public_methods(false).each do |method_name|
+        add_method(instance, method_name)
+      end
+    end
+
+    def add_method(instance, method_name)
+      define_singleton_method(method_name) do |*args|
+        instance.public_send(method_name, *args)
+      end
+    end
+  end
+end

data/lib/wykop/configuration.rb

@@ -0,0 +1,29 @@
+module Wykop
+  class Configuration
+    AUTH_KEYS = [:app_user_key, :app_username, :app_generated_key, :app_user_secret, :api_host]
+    attr_accessor(*AUTH_KEYS)
+
+    # Creates configuration
+    # @param [Hash] - hash containing config params and their values
+    # @return [Configuration] - a new configuration with the vaules from the config_hash set
+    def initialize(config_hash = nil)
+      if config_hash.is_a?(Hash)
+        config_hash.each do |config_name, config_value|
+          self.send("#{config_name}=", config_value)
+        end
+      end
+    end
+
+    # Returns a hash of api keys and their values
+    def auth_keys
+      AUTH_KEYS.inject({}) do |keys_hash, key|
+        keys_hash[key] = send(key)
+        keys_hash
+      end
+    end
+
+    def valid?
+      AUTH_KEYS.none? { |key| send(key).nil? || send(key).empty? }
+    end
+  end
+end

data/lib/wykop/error.rb

@@ -0,0 +1,14 @@
+module Wykop
+  module Error
+    # Validates Wykop API responses
+
+    class Base < StandardError;
+    end
+
+    class NoApiKeys < Base
+      def initialize(msg = "Missing API credentials.")
+        super
+      end
+    end
+  end
+end

data/lib/wykop/operations/add.rb

@@ -0,0 +1,22 @@
+module Wykop
+  module Operations
+    class Add
+      # Documentation: http://www.wykop.pl/dla-programistow/dokumentacja/#info6_9
+      def initialize(client)
+        @client = client
+        @request = Wykop::Operations::Request.new(@client)
+      end
+
+      def add_new(p = {})
+        # Adding new link
+        p.delete(:group)
+        @request.execute(replace_url( { :banana => 'add', :potato => 'index', :group => p[:group].gsub(/^\#/, '') } ), p)
+      end
+
+      def replace_url( p = {} )
+        standard_url = "#{@client.configuration.api_host}/banana/potato/appkey,#{@client.configuration.app_user_key}/userkey,#{@client.user_info['userkey']}/group,groupid"
+        return standard_url.gsub(/banana/, p[:banana]).gsub(/potato/, p[:potato]).gsub(/groupid/, p[:group])
+      end
+    end
+  end
+end

data/lib/wykop/operations/favorites.rb

@@ -0,0 +1,27 @@
+module Wykop
+  module Operations
+    class Favorites
+      # Documentation: http://www.wykop.pl/dla-programistow/dokumentacja/#info6_15
+      def initialize(client)
+        @client = client
+        @request = Wykop::Operations::Request.new(@client)
+      end
+
+      def favorite_index( p = {} )
+        return @request.execute(@request.replace_url({ :banana => 'favorites', :potato => 'index', :param1 => p[:param1] } ), Hash.new)
+      end
+
+      def favorite_comments( p = {} )
+        return @request.execute(@request.replace_url({ :banana => 'favorites', :potato => 'comments' } ), Hash.new)
+      end
+
+      def favorite_entries( p = {} )
+        return @request.execute(@request.replace_url({ :banana => 'favorites', :potato => 'entries' } ), Hash.new)
+      end
+
+      def favorite_lists( p = {} )
+        return @request.execute(@request.replace_url({ :banana => 'favorites', :potato => 'lists' } ), Hash.new)
+      end
+    end
+  end
+end

data/lib/wykop/operations/link.rb

@@ -0,0 +1,55 @@
+module Wykop
+  module Operations
+    class Link
+      # Documentation: http://www.wykop.pl/dla-programistow/dokumentacja/#info6_2
+      def initialize(client)
+        @client = client
+        @request = Wykop::Operations::Request.new(@client)
+      end
+
+      def link_index( p = {} )
+        return @request.execute(@request.replace_url({ :banana => 'links', :potato => 'index', :param1 => p[:param1] }), Hash.new)
+      end
+
+      def link_dig( p = {} )
+        return @request.execute(@request.replace_url({ :banana => 'links', :potato => 'dig', :param1 => p[:param1] }), Hash.new)
+      end
+
+      def link_cancel( p = {} )
+        return @request.execute(@request.replace_url({ :banana => 'links', :potato => 'cancel', :param1 => p[:param1] }), Hash.new)
+      end
+
+      def link_bury( p = {} )
+        return @request.execute(@request.replace_url({ :banana => 'links', :potato => 'cancel', :param1 => p[:param1], :param2 => p[:param2] }), Hash.new)
+      end
+
+      def link_comments( p = {} )
+        return @request.execute(@request.replace_url({ :banana => 'links', :potato => 'comments', :param1 => p[:param1] }), Hash.new)
+      end
+
+      def link_reports( p = {} )
+        return @request.execute(@request.replace_url({ :banana => 'links', :potato => 'reports', :param1 => p[:param1] }), Hash.new)
+      end
+
+      def link_digs( p = {} )
+        return @request.execute(@request.replace_url({ :banana => 'links', :potato => 'digs', :param1 => p[:param1] }), Hash.new)
+      end
+
+      def link_related( p = {} )
+        return @request.execute(@request.replace_url({ :banana => 'links', :potato => 'related', :param1 => p[:param1] }), Hash.new)
+      end
+
+      def link_buryreasons( p = {} )
+        return @request.execute(@request.replace_url({ :banana => 'links', :potato => 'buryreasons' }), Hash.new)
+      end
+
+      def link_observe( p = {} )
+        return @request.execute(@request.replace_url({ :banana => 'links', :potato => 'observe', :param1 => p[:param1] }), Hash.new)
+      end
+
+      def link_favorite( p = {} )
+        return @request.execute(@request.replace_url({ :banana => 'links', :potato => 'favorite', :param1 => p[:param1] }), Hash.new)
+      end
+    end
+  end
+end

data/lib/wykop/operations/links.rb

@@ -0,0 +1,18 @@
+module Wykop
+  module Operations
+    class Links
+      # Documentation: http://www.wykop.pl/dla-programistow/dokumentacja/#info6_3
+      def initialize(client)
+        @client = client
+        @request = Wykop::Operations::Request.new(@client)
+      end
+
+      def links_show( p = {} )
+        if ! p.has_key?(:category); p[:category] = 'promoted'; end
+        q_url = @request.replace_url({ :banana => 'links', :potato => p[:category]})
+        q_body = Hash.new
+        return @request.execute(q_url, q_body)
+      end
+    end
+  end
+end

data/lib/wykop/operations/message.rb

@@ -0,0 +1,30 @@
+module Wykop
+  module Operations
+    class Messages
+      # Documentation: http://www.wykop.pl/dla-programistow/dokumentacja/#info6_18
+      def initialize(client)
+        @client = client
+        @request = Wykop::Operations::Request.new(@client)
+      end
+
+      def messages_list
+        return @request.execute(@request.replace_url({ :banana => 'pm', :potato => 'conversationslist' } ), Hash.new)
+      end
+
+      def messages_read( p = {} )
+        p.delete(:param1)
+        return @request.execute(@request.replace_url({ :banana => 'pm', :potato => 'conversation', :param1 => p[:param1] } ), p)
+      end
+
+      def messages_delete( p = {} )
+        p.delete(:param1)
+        return @request.execute(@request.replace_url({ :banana => 'pm', :potato => 'deleteconversation', :param1 => p[:param1] } ), p)
+      end
+
+      def message_send( p = {} )
+        p.delete(:param1)
+        return @request.execute(@request.replace_url({ :banana => 'pm', :potato => 'sendmessage', :param1 => p[:param1] } ), p)
+      end
+    end
+  end
+end

data/lib/wykop/operations/observatory.rb

@@ -0,0 +1,35 @@
+module Wykop
+  module Operations
+    class Observatory
+      # Documentation: http://www.wykop.pl/dla-programistow/dokumentacja/#info6_14
+      def initialize(client)
+        @client = client
+        @request = Wykop::Operations::Request.new(@client)
+      end
+
+      def observatory_votes
+        q_url = @request.replace_url({ :banana => 'observatory', :potato => 'votes'})
+        q_body = Hash.new
+        @request.execute(q_url, q_body)
+      end
+
+      def observatory_comments
+        q_url = @request.replace_url({ :banana => 'observatory', :potato => 'comments'})
+        q_body = Hash.new
+        @request.execute(q_url, q_body)
+      end
+
+      def observatory_entries
+        q_url = @request.replace_url({:banana => 'observatory', :potato => 'entries'})
+        q_body = Hash.new
+        @request.execute(q_url, q_body)
+      end
+
+      def observatory_entries_comments
+        q_url = @request.replace_url({:banana => 'observatory', :potato => 'entries_comments'})
+        q_body = Hash.new
+        @request.execute(q_url, q_body)
+      end
+    end
+  end
+end

data/lib/wykop/operations/popular.rb

@@ -0,0 +1,18 @@
+module Wykop
+  module Operations
+    class Popular
+      # Documentation: http://www.wykop.pl/dla-programistow/dokumentacja/#info6_4
+      def initialize(client)
+        @client = client
+        @request = Wykop::Operations::Request.new(@client)
+      end
+
+      def popular_show( p = {} )
+        if ! p.has_key?(:category); p[:category] = 'promoted'; end
+        q_url = @request.replace_url({ :banana => 'popular', :potato => p[:category]})
+        q_body = Hash.new
+        return @request.execute(q_url, q_body)
+      end
+    end
+  end
+end

data/lib/wykop/operations/rank.rb

@@ -0,0 +1,23 @@
+module Wykop
+  module Operations
+    class Rank
+      # Documentation: http://www.wykop.pl/dla-programistow/dokumentacja/#info6_13
+      def initialize(client)
+        @client = client
+        @request = Wykop::Operations::Request.new(@client)
+      end
+
+      def rank_show( p = {} )
+        if ! p.has_key?(:order); p[:order] = 'rank'; end
+        q_url = replace_url({ :banana => 'rank', :potato => 'index', :order => p[:order] })
+        q_body = Hash.new
+        return @request.execute(q_url, q_body)
+      end
+
+      def replace_url( p = {} )
+        standard_url = "#{@client.configuration.api_host}/banana/potato/order/order_content/appkey,#{@client.configuration.app_user_key}/userkey,#{@client.user_info['userkey']}"
+        return standard_url.gsub(/banana/, p[:banana]).gsub(/potato/, p[:potato]).gsub(/order_content/, p[:order])
+      end
+    end
+  end
+end

data/lib/wykop/operations/related.rb

@@ -0,0 +1,24 @@
+module Wykop
+  module Operations
+    class Related
+      # Documentation: http://www.wykop.pl/dla-programistow/dokumentacja/#info6_10
+      def initialize(client)
+        @client = client
+        @request = Wykop::Operations::Request.new(@client)
+      end
+
+      def related_vote_up( p = {} )
+        return @request.execute(@request.replace_url({ :banana => 'related', :potato => 'plus', :param1 => p[:param1], :param2 => p[:param2] } ), Hash.new)
+      end
+
+      def related_vote_down( p = {} )
+        return @request.execute(@request.replace_url({ :banana => 'related', :potato => 'minus', :param1 => p[:param1], :param2 => p[:param2] } ), Hash.new)
+      end
+
+      def related_add( p = {} )
+        p.delete(:param1)
+        return @request.execute(@request.replace_url({ :banana => 'related', :potato => 'add', :param1 => p[:param1] } ), p)
+      end
+    end
+  end
+end

data/lib/wykop/operations/request.rb

@@ -0,0 +1,39 @@
+require 'digest/md5'
+require 'httparty'
+
+module Wykop
+  module Operations
+    class Request
+      # Class created to prepare and parse all requests, includes signing replacing parameters.
+      def initialize(client)
+        @client = client
+      end
+
+      def replace_url( p = {} )
+        standard_url = "#{@client.configuration.api_host}/banana/potato/param1/param2/appkey,#{@client.configuration.app_user_key}/userkey,#{@client.user_info['userkey']}"
+        if ! p[:param1].nil?
+          standard_url = standard_url.gsub(/param1/, p[:param1].to_s)
+        else
+          standard_url = standard_url.gsub(/\/param1/, '')
+        end
+        if ! p[:param2].nil?
+          standard_url = standard_url.gsub(/param2/, p[:param2].to_s)
+        else
+          standard_url = standard_url.gsub(/\/param2/, '')
+        end
+        return standard_url.gsub(/banana/, p[:banana]).gsub(/potato/, p[:potato])
+      end
+
+      def execute(req_url = nil, req_data = nil)
+        sorted_request_body = Hash[req_data.sort_by { |key, value| key }]
+        q_body_parsed = []
+        sorted_request_body.each do |sval|
+          q_body_parsed.push(sval[1])
+        end
+        request_signature = Digest::MD5.hexdigest(@client.configuration.app_user_secret + req_url + q_body_parsed.join(','))
+        obj = HTTParty.post(req_url.to_s, :body => req_data, :headers => {"apisign" => request_signature}).to_json
+        JSON.parse(obj)
+      end
+    end
+  end
+end