wykop 0.6

data/lib/wykop/operations/search.rb

@@ -0,0 +1,42 @@
+module Wykop
+  module Operations
+    class Search
+      # Documentation: http://www.wykop.pl/dla-programistow/dokumentacja/#info6_6_1
+      def initialize(client)
+        @client = client
+        @request = Wykop::Operations::Request.new(@client)
+      end
+
+      def search_index( p = {} )
+        if ! p.has_key?(:page); p[:page] = 0; end
+        return @request.execute(replace_url( { :banana => 'search', :potato => 'index', :page => p[:page] } ), { 'q' => p[:q] })
+      end
+
+      def search_entries( p = {} )
+        if ! p.has_key?(:page); p[:page] = 0; end
+        return @request.execute(replace_url( { :banana => 'search', :potato => 'entries', :page => p[:page] } ), { 'q' => p[:q] })
+      end
+
+      def search_profiles( p = {} )
+        if ! p.has_key?(:page); p[:page] = 0; end
+        return @request.execute(replace_url( { :banana => 'search', :potato => 'profiles', :page => p[:page] } ), { 'q' => p[:q] })
+      end
+
+      def search_links( p = {} )
+        if ! p.has_key?(:page); p[:page] = 0; end
+        p.delete(:page)
+        return @request.execute(replace_url( { :banana => 'search', :potato => 'links', :page => p[:page] } ), 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']}/paged"
+        if ! p.has_key?(:page)
+          standard_url = standard_url.gsub(/\/paged/, '')
+        else
+          standard_url = standard_url.gsub(/paged/, "page,#{p[:page]}")
+        end
+        return standard_url.gsub(/banana/, p[:banana]).gsub(/potato/, p[:potato])
+      end
+    end
+  end
+end

data/lib/wykop/operations/stream.rb

@@ -0,0 +1,26 @@
+module Wykop
+  module Operations
+    class Stream
+      # Documentation: http://www.wykop.pl/dla-programistow/dokumentacja/#info6_16
+      def initialize(client)
+        @client = client
+        @request = Wykop::Operations::Request.new(@client)
+      end
+
+      def stream_show( p = {} )
+        if ! p.has_key?(:page); p[:page] = 0; end
+        return @request.execute(replace_url({ :banana => 'stream', :potato => 'index', :page => p[:page]} ), Hash.new)
+      end
+
+      def stream_hot( p = {} )
+        if ! p.has_key?(:page); p[:page] = 0; end
+        return @request.execute(replace_url({ :banana => 'stream', :potato => 'hot', :page => p[:page]} ), Hash.new)
+      end
+
+      def replace_url(p = {} )
+        standard_url = "#{@client.configuration.api_host}/banana/potato/appkey,#{@client.configuration.app_user_key}/userkey,#{@client.user_info['userkey']}/page,#{p[:page]}"
+        return standard_url.gsub(/banana/, p[:banana]).gsub(/potato/, p[:potato])
+      end
+    end
+  end
+end

data/lib/wykop/operations/tag.rb

@@ -0,0 +1,33 @@
+module Wykop
+  module Operations
+    class Tag
+      # Documentation: http://www.wykop.pl/dla-programistow/dokumentacja/#info6_17
+      def initialize(client)
+        @client = client
+        @request = Wykop::Operations::Request.new(@client)
+      end
+
+      def tag_show( p = {} )
+        if ! p.has_key?(:page); p[:page] = 0; end
+        if ! p.has_key?(:type); p[:type] = 'index'; end
+        return @request.execute(@request.replace_url({ :banana => 'tag', :potato => p[:type], :param1 => p[:param1], :page => p[:page] } ), Hash.new)
+      end
+
+      def tag_observe( p = {} )
+        return @request.execute(@request.replace_url({ :banana => 'tag', :potato => 'observe', :param1 => p[:param1]}), Hash.new)
+      end
+
+      def tag_unobserve( p = {} )
+        return @request.execute(@request.replace_url({ :banana => 'tag', :potato => 'unobserve', :param1 => p[:param1]}), Hash.new)
+      end
+
+      def tag_block( p = {} )
+        return @request.execute(@request.replace_url({ :banana => 'tag', :potato => 'block', :param1 => p[:param1]}), Hash.new)
+      end
+
+      def tag_unblock( p = {} )
+        return @request.execute(@request.replace_url({ :banana => 'tag', :potato => 'unblock', :param1 => p[:param1]}), Hash.new)
+      end
+    end
+  end
+end

data/lib/wykop/operations/tags.rb

@@ -0,0 +1,17 @@
+module Wykop
+  module Operations
+    class Tags
+      # Documentation: http://www.wykop.pl/dla-programistow/dokumentacja/#info6_19
+      def initialize(client)
+        @client = client
+        @request = Wykop::Operations::Request.new(@client)
+      end
+
+      def tags_show
+        q_url = @request.replace_url({ :banana => 'tags', :potato => 'index' })
+        q_body = Hash.new
+        return @request.execute(q_url, q_body)
+      end
+    end
+  end
+end

data/lib/wykop/operations/top.rb

@@ -0,0 +1,52 @@
+require 'chronic'
+
+module Wykop
+  module Operations
+    class Top
+      # Documentation: http://www.wykop.pl/dla-programistow/dokumentacja/#info6_8
+      def initialize(client)
+        @client = client
+        @request = Wykop::Operations::Request.new(@client)
+      end
+
+      def top_index( p = {} )
+        if ! p.has_key?(:year); p[:year] = Chronic.parse('last year').strftime("%Y"); end
+        q_url = replace_url({ :banana => 'top', :potato => 'index', :year => p[:year]})
+        q_body = Hash.new
+        @request.execute(q_url, q_body)
+      end
+
+      def top_date( p = {} )
+        if ! p.has_key?(:page); p[:page] = 0; end
+        if ! p.has_key?(:month); p[:month] = 1; end
+        if ! p.has_key?(:year); p[:year] = Chronic.parse('last year').strftime("%Y"); end
+        q_url = replace_url({ :banana => 'top', :potato => 'date' }.merge(p))
+        q_body = {'page' => p[:page]}
+        @request.execute(q_url, q_body)
+      end
+
+      def top_hits
+        q_url = replace_url({ :banana => 'top', :potato => 'hits'})
+        q_body = Hash.new
+        @request.execute(q_url, q_body)
+      end
+
+      def replace_url( p = {} )
+      # def replace_url(banana = nil, potato = nil, year = nil, month = nil)
+        standard_url = "#{@client.configuration.api_host}/banana/potato/param1/param2/appkey,#{@client.configuration.app_user_key}/userkey,#{@client.user_info['userkey']}"
+        # Checking parameters existence and removing them from url, just in case
+        if p.has_key?(:year)
+          standard_url = standard_url.gsub(/param1/, p[:year].to_s)
+        else
+          standard_url = standard_url.gsub(/\/param1/, '')
+        end
+        if p.has_key?(:month)
+          standard_url = standard_url.gsub(/param2/, p[:month].to_s)
+        else
+          standard_url = standard_url.gsub(/\/param2/, '')
+        end
+        return standard_url.gsub(/banana/, p[:banana]).gsub(/potato/, p[:potato])
+      end
+    end
+  end
+end

data/lib/wykop/operations/user.rb

@@ -0,0 +1,55 @@
+module Wykop
+  module Operations
+    class User
+      # Documentation: http://www.wykop.pl/dla-programistow/dokumentacja/#info6_7
+      def initialize(client)
+        @client = client
+        @request = Wykop::Operations::Request.new(@client)
+      end
+
+      def login
+        # Opening new connection to wykop API. It returns configuration hash and all the client information
+        @client.user_info = login_request
+        if @client.user_info.nil?
+          return false
+        end
+        return true
+      end
+
+      def info(what = nil)
+        # Getting information about user account
+        if what == nil
+          return @client.user_info
+        else
+          return @client.user_info[what]
+        end
+      end
+
+      def favorites()
+        # Listing favourites for current user
+        return @request.execute(@request.replace_url({:banana => 'user', :potato => 'favorites'}), Hash.new)
+      end
+
+      def observed()
+        # Listing observed for current user
+        return @request.execute(@request.replace_url({:banana => 'user', :potato => 'observed'}), Hash.new)
+      end
+
+      def tags()
+        # Listing observed for current user
+        return @request.execute(@request.replace_url({:banana => 'user', :potato => 'tags'}), Hash.new)
+      end
+
+      # Needs to be here, at least till i figure out where to put it
+
+      private
+
+      def login_request(params = nil)
+        # Building request URL
+        q_body = {'login' => @client.configuration.app_username, 'accountkey' => @client.configuration.app_generated_key}
+        q_url = "#{@client.configuration.api_host}/user/login/appkey,#{@client.configuration.app_user_key}"
+        @request.execute(q_url, q_body)
+      end
+    end
+  end
+end

data/lib/wykop/version.rb

@@ -0,0 +1,3 @@
+module Wykop
+  VERSION = "0.6"
+end

data/spec/spec_helper.rb

@@ -0,0 +1,16 @@
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+
+require 'wykop'
+require 'rspec'
+
+RSpec.configure do |c|
+  c.fail_fast = true
+end
+
+CFG_USER_KEY    = ENV['WYKOP_CFG_USER_KEY']
+CFG_USER_SECRET = ENV['WYKOP_CFG_USER_SECRET']
+CFG_USER_NAME   = ENV['WYKOP_CFG_USER_NAME']
+CFG_GEN_SECRET  = ENV['WYKOP_CFG_GEN_SECRET']
+
+CLIENT = Wykop::Client.new({ app_user_key: CFG_USER_KEY, app_user_secret: CFG_USER_SECRET,app_username: CFG_USER_NAME, app_generated_key: CFG_GEN_SECRET, api_host: 'http://a.wykop.pl' })

data/spec/user_spec.rb

@@ -0,0 +1,70 @@
+require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+
+describe "User session" do
+  it "have credentials" do
+    if ENV['WYKOP_CFG_USER_KEY'].empty? ||
+      ENV['WYKOP_CFG_USER_SECRET'].empty? ||
+      ENV['WYKOP_CFG_USER_NAME'].empty? ||
+      ENV['WYKOP_CFG_GEN_SECRET'].empty?
+      fail "No ENV credentials specified."
+    end
+  end
+
+  it "can check profile / log in" do
+    if CLIENT.login
+      client_request = CLIENT.info
+      if client_request.has_key?('error')
+        message = "Error! Code: #{client_request['error']['code']} => #{client_request['error']['message']}"
+        fail message
+      elsif client_request.nil?
+        fail "Can't log in"
+      end
+    end
+  end
+
+  # Checking all available methods
+  # We skip 'add_new' to avoid spamming
+  # We skip 'observatory_entries_comments' as it throws internal API error.
+  available_methods = CLIENT.methods(false).sort - [:link_bury, :add_new, :execute, :replace_url, :login, :observatory_entries_comments, :related_add]
+  available_methods.each do |mthd|
+    it "- method check: #{mthd}" do
+      params = nil
+      # Weird functions specific
+      if mthd.to_s == 'search_index'
+        params = { :q => 'potato' }
+      elsif mthd.to_s == 'search_profiles'
+        params = { :q => 'ouna-' }
+      elsif mthd.to_s =~ /related_vote_.*/
+        params = { :param1 => 2242488, :param2 => 27794764 }
+      elsif mthd.to_s == 'favorite_index'
+        params = { :param1 => 56072 }
+      elsif mthd.to_s =~ /messages_(read|delete)/
+        params = { :param1 => 'ouna-' }
+      elsif mthd.to_s == 'message_send'
+        params = { :param1 => 'ouna-', :body => 'test wykop gem' }
+      elsif mthd.to_s =~ /link_/
+        params = { :param1 => 2248060 }
+      elsif mthd.to_s == 'tag_show'
+        params = { :param1 => 'polityka', :type => 'entries' }
+      elsif mthd.to_s =~ /tag_.*(block|observe)/
+        params = { :param1 => 'polityka' }
+      end
+      if params.nil?
+        client_request = CLIENT.send(mthd)
+      else
+        client_request = CLIENT.send(mthd, params)
+      end
+      if client_request.is_a?(Hash)
+        # Wykop API throws errors only with Hash
+        if client_request.has_key?('error') || client_request =~ /.*<title>Ups...<\/title>.*/ 
+          if client_request['error']['code'].to_s =~ /!(112|1002)/
+            # Ignoring error 112 ( user doesn't accept messages )
+            # Ignoring error 1002 ( no controller to serve this query )
+            message = "Error! Code: #{client_request['error']['code']} => #{client_request['error']['message']}"
+            fail message
+          end
+        end
+      end
+    end
+  end
+end

data/wykop.gemspec

@@ -0,0 +1,26 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'wykop/version'
+
+Gem::Specification.new do |spec|
+  spec.name = 'wykop'
+  spec.version = Wykop::VERSION
+  spec.authors = ['Lukasz Raczylo']
+  spec.email = ['lukasz@raczylo.com']
+  spec.summary = %q{Ruby client library for wykop.pl API}
+  spec.description = 'Provides easy way to interact with the Wykop.pl API in any kind of application'
+  spec.homepage = 'https://github.com/lukaszraczylo/wykop-ruby'
+  spec.license = 'MIT'
+
+  spec.files = `git ls-files -z`.split("\x0")
+  spec.executables = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ['lib']
+
+  # Requirements
+  spec.required_ruby_version = '>=1.9.2'
+  spec.add_development_dependency 'bundler', '~> 1.5'
+  spec.add_development_dependency 'rake', '~> 10.0', '>= 10.0.0'
+  spec.add_development_dependency 'rspec', '~> 2.6'
+end

metadata

@@ -0,0 +1,141 @@
+--- !ruby/object:Gem::Specification
+name: wykop
+version: !ruby/object:Gem::Version
+  version: '0.6'
+platform: ruby
+authors:
+- Lukasz Raczylo
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-12-07 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.5'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 10.0.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 10.0.0
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.6'
+description: Provides easy way to interact with the Wykop.pl API in any kind of application
+email:
+- lukasz@raczylo.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- Contributors.md
+- Gemfile
+- README.md
+- Rakefile
+- TODO.md
+- doc/diggs/add.md
+- doc/diggs/favorites.md
+- doc/diggs/links.md
+- doc/diggs/observatory.md
+- doc/diggs/popular.md
+- doc/diggs/related.md
+- doc/diggs/stream.md
+- doc/diggs/tag.md
+- doc/diggs/tags.md
+- doc/diggs/top.md
+- doc/index.md
+- doc/search.md
+- doc/user/basic.md
+- doc/user/link.md
+- doc/user/pm.md
+- doc/user/rank.md
+- lib/wykop.rb
+- lib/wykop/client.rb
+- lib/wykop/configuration.rb
+- lib/wykop/error.rb
+- lib/wykop/operations/add.rb
+- lib/wykop/operations/favorites.rb
+- lib/wykop/operations/link.rb
+- lib/wykop/operations/links.rb
+- lib/wykop/operations/message.rb
+- lib/wykop/operations/observatory.rb
+- lib/wykop/operations/popular.rb
+- lib/wykop/operations/rank.rb
+- lib/wykop/operations/related.rb
+- lib/wykop/operations/request.rb
+- lib/wykop/operations/search.rb
+- lib/wykop/operations/stream.rb
+- lib/wykop/operations/tag.rb
+- lib/wykop/operations/tags.rb
+- lib/wykop/operations/top.rb
+- lib/wykop/operations/user.rb
+- lib/wykop/version.rb
+- spec/spec_helper.rb
+- spec/user_spec.rb
+- wykop.gemspec
+homepage: https://github.com/lukaszraczylo/wykop-ruby
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 1.9.2
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.3
+signing_key: 
+specification_version: 4
+summary: Ruby client library for wykop.pl API
+test_files:
+- spec/spec_helper.rb
+- spec/user_spec.rb