wykop 0.6

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: ef857b8dc4ef8b2257e4046344fd762a49a90908
+  data.tar.gz: d009a48c9e3f1616556cf7f80c6a063c1b85f765
+SHA512:
+  metadata.gz: 60a6cf6fe39f8b6a2dda736fe6aa7a0b9db803be856faff1abae2229eb6ac69c58bc5a59eddc298e43beb3d3a60ed79e8b618c0c93127282c2317563881dee91
+  data.tar.gz: 87582eacb622ed29c125b989470cf7c7c012064865485d6a9e3b4eb6212a9d12346297dae5d8f70aaf007af783ee9e34a9a4bd06c80fd8518b55a2ff086e0b42

data/.gitignore

@@ -0,0 +1,6 @@
+sample-client.rb
+*~
+.DS_Store
+/.idea/
+Gemfile.lock
+prepare.sh

data/.travis.yml

@@ -0,0 +1,5 @@
+language: ruby
+rvm:
+  - ruby-2.1.0
+gemfile:
+  - Gemfile

data/Gemfile

@@ -0,0 +1,8 @@
+# Requirements
+source 'https://rubygems.org'
+gem 'awesome_print'
+gem 'httparty'
+gem 'chronic'
+gem 'rspec-core'
+gem 'rspec'
+gem 'rake'

data/README.md

@@ -0,0 +1,52 @@
+# Gem for wykop.pl API
+
+[![Gem Version](https://badge.fury.io/rb/wykop.svg)](http://badge.fury.io/rb/wykop) 
+[![Code Climate](https://codeclimate.com/github/lukaszraczylo/wykop-ruby/badges/gpa.svg)](https://codeclimate.com/github/lukaszraczylo/wykop-ruby) 
+[![Build Status](https://travis-ci.org/lukaszraczylo/wykop-ruby.svg?branch=master)](https://travis-ci.org/lukaszraczylo/wykop-ruby) 
+[![Gratipay](https://img.shields.io/gratipay/lukaszraczylo.svg)](https://gratipay.com/lukaszraczylo/)
+
+This is a Ruby Gem for the Wykop.pl API. It should simplify the process of consuming data from the Wykop.pl API for developers using Ruby.
+
+
+### Heads up
+
+Until version 0.9+ gem will and should be considered as 'under heavy development'. Please be aware and don't bitch too much. 
+Current gem version: [![Gem Version](https://badge.fury.io/rb/wykop.svg)](http://badge.fury.io/rb/wykop)
+
+If you'd like to contribute - I'm really happy with your pull requests so feel free!
+
+### Installation
+Add following to your application Gemfile:
+
+```
+gem 'wykop', require: 'wykop'
+```
+
+And then execute:
+
+```
+$ bundle
+```
+
+Or install it on your own:
+
+```
+$ gem install wykop
+```
+
+
+
+### Documentation
+
+* [Read the f** doc](https://github.com/lukaszraczylo/wykop-ruby/tree/master/doc/index.md)
+
+### Usage
+
+##### Basic usage
+The gem uses a client model to query against the API. To create and configure client with your API keys and make requests through that add the following:
+
+```
+require 'wykop'
+client = Wykop::Client.new( { app_user_key: WYKOP_DEV_APP_KEY, app_user_secret: WYKOP_DEV_APP_SECRET, 
+                app_generated_key: WYKOP_DEV_APP_GENERATED_KEY, app_username: WYKOP_USERNAME, api_host: 'http://a.wykop.pl' })
+```

data/Rakefile

@@ -0,0 +1,8 @@
+require 'bundler'
+Bundler::GemHelper.install_tasks
+task :default => :spec
+
+desc "Run all wykop gem specs"
+task :spec do
+  exec "rspec -c spec"
+end

data/TODO.md

@@ -0,0 +1,7 @@
+### TODO
+
+Following need some polishing & love:
+
+* add rest of wykop API functions
+* remove repetitive parts ( DRY )
+* create examples

data/doc/diggs/add.md

@@ -0,0 +1,7 @@
+## Adding new digg
+
+Adds new link to the waiting room.
+
+```
+client.add_new(:group => 'wykop', :url => 'https://github.com/lukaszraczylo/wykop-ruby', :title => 'test - wykop.pl ruby gem', :description => 'test gema dla API wykop.pl', :tags => 'programowanie ruby api usunto', :type => 'news', :plus18 => 0)
+```

data/doc/diggs/favorites.md

@@ -0,0 +1,17 @@
+## Favorites
+
+Checking list of favorite user links
+```
+client.favorite_index(:param1 => 56072)
+```
+
+Where:
+* param1 - list ID
+
+There's no parameters for following:
+
+```
+client.favorite_comments
+client.favorite_entries
+client.favorite_lists
+```

data/doc/diggs/links.md

@@ -0,0 +1,14 @@
+## Links
+
+Displays links from the main page
+
+```
+client.popular_show({:category => 'promoted'})
+```
+
+Available switches
+
+```
+* promoted
+* upcoming
+```

data/doc/diggs/observatory.md

@@ -0,0 +1,15 @@
+### Observatory
+
+```
+#Latest 50 votes
+client.observatory_votes
+
+#Latest 25 comments
+client.observatory_comments
+
+#Latest 25 microblog posts
+client.observatory_entries
+
+#Latest 25 microblog posts comments
+client.observatory_entries_comments
+```

data/doc/diggs/popular.md

@@ -0,0 +1,14 @@
+## Popular
+
+Displays links from the "ostatnio popularne" frame
+
+```
+client.popular_show({:category => 'promoted'})
+```
+
+Available switches
+
+```
+* promoted
+* upcoming
+```

data/doc/diggs/related.md

@@ -0,0 +1,20 @@
+## Related links
+
+
+#### Voting
+
+```
+client.related_vote_up(:param1 => { :param1 => 2242488, :param2 => 27794764 })
+client.related_vote_down(:param1 => { :param1 => 2242488, :param2 => 27794764 })
+```
+
+Where
+
+* param1 => digg ID
+* param2 => related ID
+
+#### Adding new
+
+```
+client.related_add({ :param1 => 2242488, :url => 'http://github.com/lukaszraczylo/wykop-ruby', :title => '(test) ruby gem dla wykop.pl', :plus18 => 0})
+```

data/doc/diggs/stream.md

@@ -0,0 +1,25 @@
+## Stream
+
+Displays information from stream ( "mikroblog" )
+
+####  stream_show
+
+Displays stream
+
+```
+client.stream_show
+
+# Displays page 3 of the stream
+client.stream_show({:page => 3})
+```
+
+####  stream_hot
+
+Displays stream from 'hot' category
+
+```
+client.stream_hot
+
+# Displays page 3 of the stream
+client.stream_hot({:page => 3})
+```

data/doc/diggs/tag.md

@@ -0,0 +1,41 @@
+## Tag
+
+Works with diggs related to tags
+
+#### tag_show
+
+Returns an array of diggs assigned to given tag
+
+```
+client.tag_show(:param1 => 'polityka', :type => 'links', :page => 3)
+```
+
+Available types:
+```
+- index ( all diggs )
+- links
+- entries ( mikroblog )
+```
+
+If no type specified it fails back to **index**
+
+
+#### tag_observe / tag_unobserve
+
+Add / remove tag from observed list
+
+```
+client.tag_observe(:param1 => 'polityka')
+client.tag_unobserve(:param1 => 'polityka')
+```
+
+Returns **error 999 / "Cos kombinujesz" ** if you apply change more than once to the same tag.
+
+#### tag_block / tag_unblock
+
+Add / remove tag from blocked list
+
+```
+client.tag_block(:param1 => 'polityka')
+client.tag_unblock(:param1 => 'polityka')
+```

data/doc/diggs/tags.md

@@ -0,0 +1,11 @@
+## Tags
+
+Displays information about top tags
+
+#### tags_show
+
+Returns an array of available tags
+
+```
+client.tags_show
+```

data/doc/diggs/top.md

@@ -0,0 +1,44 @@
+## Top
+
+Displays information about top diggs
+
+#### top_index
+
+Hits of the year
+
+```
+client.top_index
+client.top_index({:year => 2013 })
+```
+
+#### top_date
+
+Hits of the month
+
+```
+#current
+client.top_date
+
+#year
+client.top_date({:year => 2013})
+
+#year and month
+client.top_date({:year => 2013, :month => 12})
+
+#year month and page
+client.top_date({:year => 2013, :month => 12, :page => 1})
+```
+
+Default values ( if not specified ) are:
+- last year
+- January
+- 0 page ( first )
+
+
+#### top_hits
+
+Hits, random ones - from 'wybrane hity'
+
+```
+client.top_hits
+```

data/doc/index.md

@@ -0,0 +1,18 @@
+## wykop API Gem docs
+
+* User
+  * [user basics](https://github.com/lukaszraczylo/wykop-ruby/tree/master/doc/user/basic.md)
+  * [rank](https://github.com/lukaszraczylo/wykop-ruby/tree/master/doc/user/rank.md)
+  * [link](https://github.com/lukaszraczylo/wykop-ruby/tree/master/doc/user/link.md)
+  * [messages](https://github.com/lukaszraczylo/wykop-ruby/tree/master/doc/user/pm.md)
+* Diggs
+  * [add new](https://github.com/lukaszraczylo/wykop-ruby/tree/master/doc/diggs/add.md)
+  * [tags](https://github.com/lukaszraczylo/wykop-ruby/tree/master/doc/diggs/tags.md)
+  * [links](https://github.com/lukaszraczylo/wykop-ruby/tree/master/doc/diggs/links.md)
+  * [stream](https://github.com/lukaszraczylo/wykop-ruby/tree/master/doc/diggs/stream.md)
+  * [popular](https://github.com/lukaszraczylo/wykop-ruby/tree/master/doc/diggs/popular.md)
+  * [related](https://github.com/lukaszraczylo/wykop-ruby/tree/master/doc/diggs/related.md)
+  * [favorites](https://github.com/lukaszraczylo/wykop-ruby/tree/master/doc/diggs/favorites.md)
+  * [top diggs](https://github.com/lukaszraczylo/wykop-ruby/tree/master/doc/diggs/top.md)
+  * [observatory](https://github.com/lukaszraczylo/wykop-ruby/tree/master/doc/diggs/observatory.md)
+* [Search](https://github.com/lukaszraczylo/wykop-ruby/tree/master/doc/search.md)

data/doc/search.md

@@ -0,0 +1,44 @@
+### Search
+
+#### Searching index
+
+```
+client.search_index({:q => 'potato'})
+
+# Taking 3rd page of results
+client.search_index({:q => 'potato', :page => 3})
+```
+
+#### Searching entries
+
+```
+client.search_entries({:q => 'potato'})
+
+# Taking 2nd page of results
+client.search_entries({:q => 'potato', :page => 2})
+```
+
+#### Searching profiles
+
+```
+client.search_profiles({:q => 'ouna-'})
+```
+
+#### Searching links 
+
+```
+# what – rodzaj znalezisk: all (wszystkie), promoted (na głównej), archive (zarchiwizowane), duplicates (duplikaty)
+# sort – sortowanie: best (najlepsze), diggs (po liczbie wykopów), comments (po liczbie komentarzy), new (po czasie dodania)
+# kind – rodzaj znalezisk: all (wszystkie), today (dzisiaj), yesterday (wczoraj), week (ostatni tydzień), month (ostatni miesiąc), range (zakres czasu)
+
+# Searching for 'banana'
+client.search_links({:q => 'potato'})
+
+# ... and page of results
+client.search_links({:q => 'potato', :page => 2})
+
+# ... from the main page
+client.search_links({:q => 'potato', :page => 2, :what => 'promoted'})
+
+# ... etc.
+```

data/doc/user/basic.md

@@ -0,0 +1,81 @@
+### User
+
+#### Logging in
+
+```
+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' })
+if client.login
+	(...)
+end
+```
+
+#### Getting user favorites
+
+```
+client.favorites
+```
+
+#### Getting user observed diggs
+
+```
+client.observed
+```
+
+#### Getting user observed tags
+
+```
+client.tags
+```
+
+#### Getting user information
+
+```
+client.info
+```
+
+Returns all available client information ( after successful log in )
+
+```
+client.info('signup_date')
+```
+
+Returns sign up date for client account. Acceptable parameters:
+
+```
+{
+               "login" => "ouna-",
+               "email" => "224af1bddf5::banana",
+        "public_email" => "",
+                "name" => "",
+                 "www" => "",
+              "jabber" => "",
+                  "gg" => "",
+                "city" => "",
+               "about" => "Sysadmin.",
+        "author_group" => 1,
+         "links_added" => 71,
+     "links_published" => 6,
+            "comments" => 2617,
+                "rank" => 1380,
+           "followers" => 20,
+           "following" => 5,
+             "entries" => 5,
+    "entries_comments" => 15,
+               "diggs" => 3971,
+              "buries" => 1521,
+              "groups" => 0,
+       "related_links" => 59,
+         "signup_date" => "2007-12-04 11:50:25",
+              "avatar" => "http://xG.cdn03.imgwykop.pl/c3397992/ouna-_GMaL3lbIGi,q60.jpg",
+          "avatar_big" => "http://xG.cdn03.imgwykop.pl/c3397992/ouna-_GMaL3lbIGi,q150.jpg",
+          "avatar_med" => "http://xG.cdn03.imgwykop.pl/c3397992/ouna-_GMaL3lbIGi,q48.jpg",
+           "avatar_lo" => "http://xG.cdn03.imgwykop.pl/c3397992/ouna-_GMaL3lbIGi,q30.jpg",
+         "is_observed" => nil,
+          "is_blocked" => nil,
+                 "sex" => "male",
+                 "url" => "http://www.wykop.pl/ludzie/ouna-/",
+       "violation_url" => nil,
+             "userkey" => "aooo::potato"
+}
+```