greentext 0.3.0 → 0.3.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: c7ba122616e32e4f72fcf28eece5496993aca498
-  data.tar.gz: 301ad86a4d16613ded9a9a9e43a4cdd0b2018289
+  metadata.gz: aea6f17edaac64598a494d1a439d5db64b98230f
+  data.tar.gz: 06f28533e8e7cc84713f1d581778ce27989e9569
 SHA512:
-  metadata.gz: 8af2f6b6277a4acc059445cf6735347e7946bfbed47d5c7dc1e39b9c622306fbf3bd5cf5055f56f7665f59ac7c6f11b61634963afff55401fe6f4229426d8568
-  data.tar.gz: f7fe8d1809779ba7b6b437e7a453479802402486a01d630c1e9b7b0bed96976c67718a10ef4e0f75cd4fd90d43f685702b50785054f42dc736b3437c96cde8c9
+  metadata.gz: 5a4c9edbd694256e8990774ca31b93bf6ac62d65058fcfbd004c3542a2cfaed812278de462b111ec26b02888a665ee4cfaee2cc728562587a5a0bacd52c16ea2
+  data.tar.gz: 9ef8f01dccf3d3d01f4734c56ec42290f16c4dd85bf18b24b7a096dcde9ec0954e937f8a122e149a8c4fc2d641655fee80de9b4a5f8556eca5090880b2aff2b9

data/README.md

@@ -1,4 +1,5 @@
-**Greentext** *Unofficial 4chan API Client.*
+**Greentext**
+*Unofficial [4chan's JSON API](https://github.com/4chan/4chan-API) Wrapper for Ruby.*
 
 [![Gem Version](https://badge.fury.io/rb/greentext.svg)](http://badge.fury.io/rb/greentext)
 [![Dependency Status](https://gemnasium.com/avidw/greentext.svg)](https://gemnasium.com/avidw/greentext)
@@ -6,71 +7,46 @@
 
 ---
 
-## Usage
-### Greentext::Dirty
-
-I'm still working on the main implementation. Meanwhile, one
-way of getting data from the API is using `Greentext::Dirty`.
-
-```ruby
-require "greentext/dirty"
-dirty = Greentext::Dirty.new
+## Installation
 
-boards = dirty.boards
-# => [{"board"=>"3", "title"=>"3DCG" ... }, {"board"=>"a" ...
+Add this line to your application's Gemfile:
 
-board = dirty.board(:v)
-# => [{:no=>543128225, :last_modified=>1398021394}, {:no=> ...
+    gem "greentext"
 
-thread = dirty.thread(:v, 543125139)
-# => [{:no=>543125139, :now=>"04/20/14(Sun)14:28:49", ...
+And then execute:
 
-thread.first[:time]
-# => #<DateTime: 2014-04-20T18:28:49+00:00 ((2456768j,66529s,0n),+0s,2299161j)>
+    $ bundle
 
-thread.first[:url]
-# => "http://boards.4chan.org/b/res/543125139#p543128395"
-```
+Or install it yourself as:
 
-### Greentext::Client
+    $ gem install greentext
 
-Haven't implemented it yet :neutral_face:.  
-Meanwhile, use `Greentext::Dirty`.
+## Usage
 
 ```ruby
 require "greentext"
 
-client = Greentext::Client.new
-# => #<Greentext::Client:0x007f9f9a624260 @base_uri="http://a.4cdn.org/">
+client = Greentext.client
+# => #<Greentext::Client:0x007f9f9a624260 @api_endpoint="http://a.4cdn.org/">
 
-cg = client.boards.first
-# => #<Greentext::Client::Board:0x007f9f9aa10928 @attrs={"board"=>"3", "title"=>"3DCG", "ws_board"=>1, ... }>
-cg.title
+board = client.boards.first
+# => #<Greentext::Board:0x007f9f9aa10928 @attrs={"board"=>"3", "title"=>"3DCG", "ws_board"=>1, ... }>
+board.title
 # => "3DCG"
-cg.ws_board?
+board.worksafe?
 # => true
 
-post = cg.threads.first
-# => #<Greentext::Client::Post:0x005f4f9aa12393 @attrs={"no"=>240555661, "now"=>"04\/21\/14(Mon)13:26:27", ... }>
-post.time
+thread = board.threads.first
+# => #<Greentext::Post:0x005f4f9aa12393 @attrs={"no"=>240555661, "now"=>"04\/21\/14(Mon)13:26:27", ... }>
+thread.time
 # => #<DateTime: 2014-04-21T18:24:10+00:00 ((2456769j,66250s,699039399n),+0s,2299161j)>
-post.comment
+thread.comment
 # => "Love it. Looks like there&#039;s going to be ton of secret ... "
-```
 
-## Installation
-
-Add this line to your application's Gemfile:
-
-    gem "greentext"
-
-And then execute:
-
-    $ bundle
-
-Or install it yourself as:
-
-    $ gem install greentext
+# Get the rest of the thread from OP's post
+all_posts = thread.expand
+# => [#<Greentext::Post:0x005f4f9aa26345>, #<Greentext::Post:0x005f4f9aa27456>
+```
 
 ## Contributing
 

data/greentext.gemspec

@@ -2,12 +2,12 @@
 
 Gem::Specification.new do |s|
   s.name          = "greentext"
-  s.version       = "0.3.0"
+  s.version       = "0.3.1"
   s.authors       = ["Avinash Dwarapu"]
   s.email         = ["d.nash.avi@gmail.com"]
   s.summary       = %q{Unofficial API for 4chan.}
   s.description   = %q{Unofficial API for 4chan.}
-  s.homepage      = "https://github.com/avidw/greentext"
+  s.homepage      = "https://avidw.github.io/greentext"
   s.license       = "MIT"
 
   s.files         = `git ls-files -z`.split("\x0")

data/lib/greentext.rb

@@ -18,8 +18,11 @@ module Greentext
     private
 
     def method_missing(method_name, *args, &block)
-      return super unless client.respond_to?(method_name)
-      client.send(method_name, *args, &block)
+      if client.respond_to?(method_name)
+        client.send(method_name, *args, &block)
+      else
+        super
+      end
     end
   end
 end

data/lib/greentext/board.rb

@@ -8,7 +8,7 @@ module Greentext
     attr_reader :posts_per_page, :per_page
     attr_reader :pages
     attr_predicate :worksafe, :ws_board
-     
+
     def threads
       Greentext.client.threads(self)
     end

data/lib/greentext/client/board.rb

@@ -14,11 +14,12 @@ module Greentext
 
       # Public: List all available threads in a board.
       #
-      # board - A Greentext::Board object.
+      # board - A Greentext::Board object or a board name String/Symbol.
       #
       # Returns an Array of Greentext::Post instances.
       def threads(board)
-        get("/#{board.name}/catalog.json")
+        name = board.is_a?(Greentext::Board) ? board.name : board
+        get("/#{name}/catalog.json")
           .map { |page| page["threads"] }.flatten
           .map { |thread| Greentext::Post.new(thread.merge("board" => board)) }
       end

data/lib/greentext/client/post.rb

@@ -18,7 +18,7 @@ module Greentext
             Greentext::Post.new(params)
           end
         else
-          raise ArgumentError, "This is not the first post in the thread."
+          fail ArgumentError, "This is not the first post in the thread."
         end
       end
     end

data/lib/greentext/post.rb

@@ -39,21 +39,32 @@ module Greentext
     #
     # Returns a Hash.
     def image
-      {
-        width: @attrs['w'],
-        height: @attrs['h'],
-        filename: @attrs['tim'],
-        md5: @attrs['md5'],
-        url: "https://i.4cdn.org/#{@attrs['board']}/#{@attrs['tim']}.#{@attrs['ext']}"
-      }
+      if @attrs["tim"]
+        {
+          width: @attrs["w"],
+          height: @attrs["h"],
+          filename: @attrs["tim"],
+          md5: @attrs["md5"],
+          url: "https://i.4cdn.org/#{@attrs['board'].name}/" \
+               "#{@attrs['tim']}#{@attrs['ext']}"
+        }
+      else
+        {}
+      end
     end
 
     # Public: Get information about the thumbnail of the image.
     #
     # Returns a Hash.
     def thumbnail
-      { width: @attrs["tn_w"], height: @attrs["tn_h"],
-        url: "https://t.4cdn.org/#{@attrs['board']}/#{@attrs['tim']}s.jpg" }
+      if @attrs["tim"]
+        { width: @attrs["tn_w"], height: @attrs["tn_h"],
+          url: "https://t.4cdn.org/#{@attrs['board'].name}/" \
+               "#{@attrs['tim']}s.jpg" 
+        }
+      else
+        {}
+      end
     end
 
     # Public: Determines if the post is OP.

data/spec/board_spec.rb

@@ -10,14 +10,15 @@ describe Greentext::Board, :vcr do
       expect(@client.boards.sample).to be_an_instance_of(Greentext::Board)
     end
   end
-  
+
   describe "#threads" do
     it "gets an Array of posts" do
       expect(@client.threads(@client.boards.sample)).to be_an(Array)
     end
 
     it "converts objects to Greentext::Post instances" do
-      expect(@client.threads(@client.boards.sample).sample).to be_an_instance_of(Greentext::Post)
+      expect(@client.threads(@client.boards.sample).sample)
+      .to be_an_instance_of(Greentext::Post)
     end
   end
 end

data/spec/post_spec.rb

@@ -1 +1 @@
-require "spec_helper"
+require "spec_helper"

data/spec/spec_helper.rb

@@ -3,7 +3,7 @@ require "webmock/rspec"
 require "vcr"
 
 VCR.configure do |c|
-  c.default_cassette_options = {record: :new_episodes}
+  c.default_cassette_options = { record: :new_episodes }
   c.cassette_library_dir = "spec/cassettes"
   c.hook_into :webmock
 end
@@ -17,13 +17,13 @@ RSpec.configure do |c|
   c.before :all do
     @client = Greentext.client
   end
-  
+
   c.around(:each, :vcr) do |example|
     name = example.metadata[:full_description]
       .split(/\s+/, 2)
       .join("/")
       .downcase
-      .tr(' ', '_')
+      .tr(" ", "_")
       .gsub(/[^\w\/]+/, "_")
     VCR.use_cassette(name) { example.call }
   end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: greentext
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.3.1
 platform: ruby
 authors:
 - Avinash Dwarapu
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-04-24 00:00:00.000000000 Z
+date: 2014-04-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -158,13 +158,12 @@ files:
 - lib/greentext/client.rb
 - lib/greentext/client/board.rb
 - lib/greentext/client/post.rb
-- lib/greentext/dirty.rb
 - lib/greentext/post.rb
 - spec/board_spec.rb
 - spec/client_spec.rb
 - spec/post_spec.rb
 - spec/spec_helper.rb
-homepage: https://github.com/avidw/greentext
+homepage: https://avidw.github.io/greentext
 licenses:
 - MIT
 metadata: {}

data/lib/greentext/dirty.rb

@@ -1,36 +0,0 @@
-require "faraday"
-require "json"
-
-module Greentext
-  # Public: Crudely written but quick way to access the 4chan API.
-  # Surprisingly, Rubocop's pretty okay with this mess.
-  class Dirty
-    def boards
-      get("/boards.json")["boards"]
-    end
-
-    def threads(board)
-      get("/#{board}/threads.json")
-      .map { |page| page["threads"] }.flatten
-      .map { |thread| symbolize(thread) }
-    end
-    alias_method :board, :threads
-
-    def posts(board, thread)
-      get("/#{board}/res/#{thread}.json")["posts"]
-      .map { |post| symbolize(post) }
-    end
-    alias_method :thread, :posts
-
-    private
-
-    def get(path)
-      res = Faraday.new(url: "http://a.4cdn.org/").get(path).body
-      JSON.parse(res) if res.length > 2
-    end
-
-    def symbolize(hash)
-      Hash[hash.map { |k, v| [k.to_sym, v] }]
-    end
-  end
-end