devrant 0.0.2 → 0.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 3c4da7cf8bf7d3411efba3fcd419ec1e7a64fb1e
-  data.tar.gz: f81698d5ccdd68f4af78ab16d94db11c46d06efa
+  metadata.gz: b09d803f04ef0c5eafeb8fd121a8d2576f869828
+  data.tar.gz: c9714660e2855e4f5a88db7b04268a5589450874
 SHA512:
-  metadata.gz: 506beae8ed00d19c049806f4a56d71011c866a3328339102c8c04ce9726c0ba70c28214c2699b98de80b50943248f8fa9c70d7d22eea797941967dd1c8e1acae
-  data.tar.gz: fd98539b4fecc834cc1ce02a6a115039ee07e20ac69f36a27e6f67c252df6a260436cea59adb663c5e7c7fb91f620733f14abf3b08186abf3a4747e69070e2ce
+  metadata.gz: 22bcbbff65d5075d683ccf82a0cb606c38940a3c946dce3e59755f00aa4538f08bc5f81d77340bf1c3f7487c9da70966199d22ede57d085f9bf900e1b8c2b3bc
+  data.tar.gz: 596be6cad8543e251f2cb4273ecf458badd7f2c9f4ae25745242936fe143f0cab9c1ba3e7c519d7177e960f3383b3144f4c47c9c2d751166e18173f5a669cb90

data/.gitignore

@@ -10,3 +10,4 @@
 
 # rspec failure tracking
 .rspec_status
+.gem

data/README.md

@@ -1,5 +1,9 @@
+[![Gem Version](https://badge.fury.io/rb/devrant.svg)](https://badge.fury.io/rb/devrant)
+
 # Devrant
 
+![devRant](https://devrant.com/static/devrant/img/landing/features-avatars.png)
+
 This gem is the unnofficial wrapper for the devRant API. It provides convinience methods and an interface to easily integrate devRant into
 your ruby projects.
 
@@ -35,14 +39,62 @@ devRant = Devrant::Api.new
 
 ### Rants
 
-Getting all rants:
+**Getting all rants:**
+
+```ruby
+require 'devrant'
+
+devRant = Devrant::Api.new
+
+devRant.rants.all
+```
+
+**Getting rant by ID:**
+
+```ruby
+require 'devrant'
+
+devRant = Devrant::Api.new
+
+devRant.rants.get_rant(1234)
+```
+
+**Filtering Rants**
+
+Allows you to fetch rants based on certain filters. Takes in a hash of parameters.
+
+| Method  | Parameters      |
+|:--------|:----------------|
+|get_rants|limit, sort, skip|
+
+_Parameter Values_
+
+| Parameter      | Values    | Description                                         |
+|:---------------|:----------|:----------------------------------------------------|
+|limit _Optional_|any integer| Sets a maximum limit to the amount of rants returned|
+|sort _Optional_ |'recent', 'algo', 'top'| Specifies order in which to sort the rants|
+|skip _Optional_ |any integer| Specifies how many rants to skip. Useful for pagination|
+
+_Example:_
+
+```ruby
+require 'devrant'
+
+devRant = Devrant::Api.new
+
+devRant.rants.get_rants({limit: 10, sort: 'algo', skip: 5})
+```
+
+### Users
+
+**Getting User by ID:**
 
 ```ruby
 require 'devrant'
 
 devRant = Devrant::Api.new
 
-devRant.rants.get_rants
+devRant.users.get_user(1234)
 ```
 
 ## Development

data/Rakefile

@@ -7,4 +7,12 @@ task :default => :spec
 
 task :console do
   exec 'irb -r devrant -I ./lib'
-end
+end
+
+task :export do
+#  exec 'rake'
+ # exec 'gem build devrant.gemspec'
+
+  new_gem = Dir.glob("/pkg/*").max_by {|f| File.mtime(f)}
+  puts new_gem
+end

data/devrant.gemspec

@@ -23,6 +23,7 @@ Gem::Specification.new do |spec|
 
   spec.add_development_dependency 'bundler', '~> 1.15'
   spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'pry'
   spec.add_development_dependency 'rspec', '~> 3.0'
   spec.add_runtime_dependency 'httparty'
   spec.add_runtime_dependency 'json'

data/lib/devrant.rb

@@ -1,6 +1,7 @@
 require "devrant/version"
 require "httparty"
 require "json"
+require "pry"
 require "devrant/api"
 require "devrant/rants"
 require "devrant/users"

data/lib/devrant/api.rb

@@ -2,7 +2,7 @@ module Devrant
   class Api
     HTTP_OPTIONS = {
       query: {
-        app: 3
+        app: 3 # This is a temporary validation param that will likely be removed soon
       },
       base_uri: 'https://www.devrant.io/api'
     } 
@@ -28,4 +28,4 @@ module Devrant
       end
     end
   end
-end
+end

data/lib/devrant/rants.rb

@@ -1,7 +1,7 @@
 module Devrant
   class Rants
     include HTTParty
-    include Devrant
+    include Devrant    
 
     def all
       structuralize(self.class.get('/devrant/rants')).rants
@@ -15,6 +15,14 @@ module Devrant
       raise ArgumentError.new("No rant found for id #{id}")
     end
 
+    def get_rants(params={})
+      options = {
+        query: self.class.default_options[:query].merge(params)
+      }
+
+      rants = structuralize(self.class.get("/devrant/rants", options)).rants 
+    end
+
   end
 end
 

data/lib/devrant/users.rb

@@ -0,0 +1,14 @@
+module Devrant
+  class Users
+    include HTTParty
+    include Devrant
+
+    def get_user(id)
+      user = structuralize(self.class.get("/users/#{id}")).profile
+
+      return user unless user.nil?
+
+      raise ArgumentError.new("No user found for id #{id}")
+    end
+  end
+end

data/lib/devrant/version.rb

@@ -1,3 +1,3 @@
 module Devrant
-  VERSION = "0.0.2"
+  VERSION = "0.0.3"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: devrant
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.3
 platform: ruby
 authors:
 - Alex Dovzhanyn
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-11-01 00:00:00.000000000 Z
+date: 2017-11-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -38,6 +38,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -98,10 +112,12 @@ files:
 - Rakefile
 - bin/console
 - bin/setup
+- devrant-0.0.2.gem
 - devrant.gemspec
 - lib/devrant.rb
 - lib/devrant/api.rb
 - lib/devrant/rants.rb
+- lib/devrant/users.rb
 - lib/devrant/version.rb
 homepage: https://github.com/alexdovzhanyn/devrant
 licenses:
@@ -123,7 +139,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.8
+rubygems_version: 2.6.14
 signing_key: 
 specification_version: 4
 summary: The Unofficial devRant ruby API client