greentext 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 219465b29edc32e5ba85d822d9b08f353a559808
-  data.tar.gz: 48a6b15ddea763362e67106088040dceaa4d5f95
+  metadata.gz: 70e6ce509e15bac2d2e63dad243d7ce386d7cffb
+  data.tar.gz: 8fa2485f164f343aa72540210285c378d33cc901
 SHA512:
-  metadata.gz: 21abfe740a2cc63e9236cacf0a69abaab5dde707f88f802c3015bffaa2f953bc3a52ec3ce2d7296727f4d9b7c47ab546cd0f77dfbb3e703f9ec2166efbba4969
-  data.tar.gz: 3c3899bc4bd78d75801f81d2bdcd0b028316efe259293d41eacb99f43ec086682056a25d19a951df78d5bb174b6e0c079bf1a8ed3511c232bbf67d3eea50eec9
+  metadata.gz: 08ac112408c79420c2cda4af93caeca85ea4ee1587e06f4dd517db646b36d7e2cfe5203b3f3370aead01288213fdc15f939b5129da79cb2defd3a0c58ad430d9
+  data.tar.gz: 603b286fe5603f64b871717a3b944fdf3843318f0763af5b9036c94305935374927b78b43a52a9dc320d117155b167458d8638447bd54b0cdc4154aa41857d5b

data/.gitignore

@@ -7,6 +7,7 @@ Gemfile.lock
 InstalledFiles
 _yardoc
 coverage
+spec/cassettes/
 doc/
 lib/bundler/man
 pkg

data/README.md

@@ -1,19 +1,16 @@
-**Greentext** *Unofficial 4chan API.*  
-By Avinash Dwarapu
+**Greentext** *Unofficial 4chan API Client.*
 
-**
-[Usage](#usage) |
-[Installation](#installation) |
-[Contributing](#contributing)
-**
+[![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)
+[![Build Status](https://travis-ci.org/avidw/greentext.svg)](https://travis-ci.org/avidw/greentext)
 
-## Usage
-### Greentext::Client
-Haven't implemented it yet :neutral_face:
+---
 
+## Usage
 ### Greentext::Dirty
-Aside from the main implementation, there is also a quick
-way of getting data from the API using `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"
@@ -35,11 +32,37 @@ thread.first[:url]
 # => "http://boards.4chan.org/b/res/543125139#p543128395"
 ```
 
+### Greentext::Client
+
+Haven't implemented it yet :neutral_face:.  
+Meanwhile, use `Greentext::Dirty`.
+
+```ruby
+require "greentext"
+
+client = Greentext::Client.new
+# => #<Greentext::Client:0x007f9f9a624260 @base_uri="http://a.4cdn.org/">
+
+cg = client.boards.first
+# => #<Greentext::Client::Board:0x007f9f9aa10928 @attrs={"board"=>"3", "title"=>"3DCG", "ws_board"=>1, ... }>
+cg.title
+# => "3DCG"
+cg.ws_board?
+# => true
+
+post = cg.threads.first
+# => #<Greentext::Client::Post:0x005f4f9aa12393 @attrs={"no"=>240555661, "now"=>"04\/21\/14(Mon)13:26:27", ... }>
+post.time
+# => #<DateTime: 2014-04-21T18:24:10+00:00 ((2456769j,66250s,699039399n),+0s,2299161j)>
+post.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'
+    gem "greentext"
 
 And then execute:
 
@@ -53,6 +76,18 @@ Or install it yourself as:
 
 1. Fork it ( http://github.com/avidw/greentext/fork )
 2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Install development requirements (`bundle install`)
 3. Commit your changes (`git commit -am 'Add some feature'`)
 4. Push to the branch (`git push origin my-new-feature`)
 5. Create new Pull Request
+
+---
+
+This project follows the [Ruby Style Guide](https://github.com/bbatsov/ruby-style-guide) 
+aside from a couple of differences:
+
+- Documented using TomDoc instead of RDoc.
+- Double quotes are always preferred over single quotes unless escaping them becomes a nightmare.  
+- There are no spaces around `=` for default arguments in a method. This is just a personal thing.
+
+Double check the code using `bundle exec rubocop` before submitting a pull request.

data/greentext.gemspec

@@ -2,7 +2,7 @@
 
 Gem::Specification.new do |s|
   s.name          = "greentext"
-  s.version       = "0.1.0"
+  s.version       = "0.2.0"
   s.authors       = ["Avinash Dwarapu"]
   s.email         = ["d.nash.avi@gmail.com"]
   s.summary       = %q{Unofficial API for 4chan.}
@@ -15,9 +15,10 @@ Gem::Specification.new do |s|
   s.test_files    = s.files.grep(%r{^(test|spec|features)/})
   s.require_paths = ["lib"]
   
+  s.add_dependency "bundler", "~> 1.6"
+  s.add_dependency "memoizable", "~> 0.4"
   s.add_dependency "faraday", "~> 0.9"
-  s.add_dependency "memoizable", "~> 0.4.2"
-  s.add_dependency "oj"
+  s.add_dependency "faraday_middleware", "~> 0.9"
   
   s.add_development_dependency "rubocop"
   s.add_development_dependency "rspec"

data/lib/greentext.rb

@@ -0,0 +1,25 @@
+require "greentext/client"
+
+# Public: The main Greentext module.
+module Greentext
+  class << self
+    # Public: An instance of the client when calling methods
+    #   on the Greentext module.
+    #
+    #   Returns an Instance of Greentext::Client
+    def client
+      @client ||= Greentext::Client.new
+    end
+
+    def respond_to?(method_name, include_private=false)
+      client.respond_to?(method_name, include_private) || super
+    end
+
+    private
+
+    def method_missing(method_name, *args, &block)
+      return super unless client.respond_to?(method_name)
+      client.send(method_name, *args, &block)
+    end
+  end
+end

data/lib/greentext/base.rb

@@ -0,0 +1,57 @@
+require "memoizable"
+require "time"
+
+module Greentext
+  # Internal: The base class for the models.
+  class Base
+    include Memoizable
+    attr_reader :attrs
+    alias_method :to_h, :attrs
+
+    class << self
+      # Internal: Dynamically define an attribute method for a given attribute
+      #
+      # key   - A Symbol of the method name.
+      # value - An optional Symbol of the attribute key.
+      #
+      # Yields an optional attribute key.
+      #
+      # Returns nothing.
+      def attr_reader(key, value=key)
+        define_method(key) { @attrs[value.to_s] }
+        memoize(key)
+      end
+
+      # Internal: Dynamically define a predicate method for a given attribute.
+      #
+      # key   - A Symbol of the method name.
+      # value - An optional Symbol of the attribute key.
+      #
+      # Returns nothing.
+      def attr_predicate(key, value=key)
+        define_method(:"#{key}?") { @attrs[value.to_s] == 1 }
+        memoize(:"#{key}?")
+      end
+
+      # Internal: Dynamically define an date method for a given attribute.
+      #
+      # key   - A Symbol of the method name.
+      # value - An optional Symbol of the attribute key.
+      #
+      # Returns nothing.
+      def attr_epoch(key, value=key)
+        define_method(key) { DateTime.strptime(@attrs[value.to_s].to_s, "%s") }
+        memoize(key)
+      end
+    end
+
+    # Internal: Initialize a new Object with given attributes.
+    #
+    # attrs - An optional Hash of attributes.
+    #
+    # Returns an instance of the Object
+    def initialize(attrs)
+      @attrs = attrs
+    end
+  end
+end

data/lib/greentext/board.rb

@@ -0,0 +1,12 @@
+require "greentext/base"
+
+module Greentext
+  # Public: (Model) A 4chan board.
+  class Board < Greentext::Base
+    attr_reader :name, :board
+    attr_reader :title
+    attr_reader :posts_per_page, :per_page
+    attr_reader :pages
+    attr_predicate :worksafe, :ws_board
+  end
+end

data/lib/greentext/client.rb

@@ -0,0 +1,53 @@
+require "faraday"
+require "faraday_middleware"
+
+require "greentext/client/board"
+require "greentext/client/post"
+
+module Greentext
+  # Public: The Client to access the API
+  #
+  # Examples
+  #   client = Greentext::Client.new
+  #   client.boards
+  #   # => [#<Greentext::Board>, ...
+  class Client
+    include Greentext::Client::Board
+    include Greentext::Client::Post
+
+    attr_accessor :api_endpoint
+
+    def initialize
+      yield self if block_given?
+    end
+
+    # Public: Get the API Endpoint
+    #
+    # Returns a String containing a URI.
+    def api_endpoint
+      @api_endpoint ||= "http://a.4cdn.org/"
+    end
+
+    private
+
+    # Private: Return the current Faraday connection or create a new one.
+    #
+    # Returns a Faraday session.
+    def connection
+      @connection ||= Faraday.new(url: api_endpoint) do |conn|
+        conn.response :json
+        conn.adapter Faraday.default_adapter
+      end
+    end
+
+    # Private: Send a GET request to the path provided.
+    #
+    # path   - The path String under the base url to access.
+    # params - An optional params Hash.
+    #
+    # Returns a Faraday Response object.
+    def get(path, params={})
+      connection.get(path, params).body
+    end
+  end
+end

data/lib/greentext/client/board.rb

@@ -0,0 +1,27 @@
+require "greentext/board"
+
+module Greentext
+  class Client
+    # Internal: Methods for interacting with boards.
+    module Board
+      # Public: List all the boards available.
+      #
+      # Returns an Array of Greentext::Board instances.
+      def boards
+        boards = get("/boards.json")["boards"]
+        boards.map { |board| Greentext::Board.new(board) }
+      end
+
+      # Public: List all available threads in a board.
+      #
+      # board - A Greentext::Board object.
+      #
+      # Returns an Array of Greentext::Post instances.
+      def threads(board)
+        get("/#{board.name}/catalog.json")
+          .map { |page| page["threads"] }.flatten
+          .map { |thread| Greentext::Post.new(thread.merge("board" => board)) }
+      end
+    end
+  end
+end

data/lib/greentext/client/post.rb

@@ -0,0 +1,27 @@
+require "greentext/post"
+
+module Greentext
+  class Client
+    # Internal: Methods for interacting with posts
+    module Post
+      # Public: Get the replies to a Greentext::Post object.
+      #   This will only work if the post is OP.
+      #
+      # post - a Greentext::Post object.
+      #
+      # Returns an Array of Greentext::Post instances.
+      def expand(post)
+        if post.op?
+          posts = get("/#{post.board.name}/res/#{post.no}.json")["posts"]
+          posts.shift # Remove OP's post
+          posts.map do |params|
+            params.merge!("board" => post.board)
+            Greentext::Post.new(params)
+          end
+        else
+          raise ArgumentError, "This is not the first post in the thread."
+        end
+      end
+    end
+  end
+end

data/lib/greentext/dirty.rb

@@ -1,15 +1,9 @@
 require "faraday"
-require "cgi"
-require "oj"
+require "json"
 
 module Greentext
   # Public: Crudely written but quick way to access the 4chan API.
   # Surprisingly, Rubocop's pretty okay with this mess.
-  #
-  # Examples
-  #
-  #   Greentext.new.threads(:b)
-  #   # => [{"no" => 543103136, "last_modified" => 1398012243}, ...
   class Dirty
     def boards
       get("/boards.json")["boards"]
@@ -18,33 +12,25 @@ module Greentext
     def threads(board)
       get("/#{board}/threads.json")
       .map { |page| page["threads"] }.flatten
-      .map { |post| Hash[post.map { |k, v| [k.to_sym, v] }] }
+      .map { |thread| symbolize(thread) }
     end
     alias_method :board, :threads
 
     def posts(board, thread)
       get("/#{board}/res/#{thread}.json")["posts"]
-        .sort_by { |h| h["resto"] }
-        .map do |post|
-          post.merge!("time" => DateTime.strptime(post["time"].to_s, "%s"))
-          post.merge!("name" => nil) if post["name"] == "Anonymous"
-          post["url"] =
-            "http://boards.4chan.org/#{board}/res/" \
-            "#{post['resto'] == 0 ? post['no'] : post['resto']}#p#{post['no']}"
-          Hash[post.map { |k, v| [k.to_sym, v] }]
-        end
+      .map { |post| symbolize(post) }
     end
     alias_method :thread, :posts
 
     private
 
     def get(path)
-      res = Faraday.new(url: "http://a.4cdn.org/").get(path)
-      if res.headers["Content-Type"] == "application/json"
-        Oj.load(res.body)
-      else
-        res
-      end
+      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

data/lib/greentext/post.rb

@@ -0,0 +1,66 @@
+require "greentext/base"
+
+module Greentext
+  # Public: (Model) A 4chan post in a thread.
+  class Post < Greentext::Base
+    attr_reader :no
+    attr_reader :resto
+    attr_reader :board
+
+    attr_epoch :time
+    attr_epoch :last_modified
+
+    attr_reader :trip
+    attr_reader :id
+    attr_reader :country
+    attr_reader :country_name
+    attr_reader :email
+    attr_reader :subject, :sub
+    attr_reader :comment, :com
+    attr_reader :custom_spoiler
+    attr_reader :omitted_posts
+    attr_reader :omitted_images
+    attr_reader :replies
+    attr_reader :images
+    attr_reader :capcode_replies
+    attr_reader :tag
+    attr_reader :semantic_url
+
+    attr_predicate :sticky
+    attr_predicate :closed
+    attr_predicate :deleted
+    attr_predicate :spoiler
+    attr_predicate :bump_limit_reached, :bumplimit
+    attr_predicate :image_limit_reached, :imagelimit
+
+    attr_predicate :image, :filename
+
+    # Public: Get information about the image attached to the post.
+    #
+    # 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']}"
+      }
+    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" }
+    end
+
+    # Public: Determines if the post is OP.
+    #
+    # Returns a Boolean value.
+    def op?
+      @attrs["resto"] == 0
+    end
+  end
+end

data/spec/board_spec.rb

@@ -0,0 +1,23 @@
+require "spec_helper"
+
+describe Greentext::Board, :vcr do
+  describe "#boards" do
+    it "gets an Array of boards" do
+      expect(@client.boards).to be_an(Array)
+    end
+
+    it "converts objects to Greentext::Board instances" 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)
+    end
+  end
+end

data/spec/client_spec.rb

@@ -0,0 +1,7 @@
+require "spec_helper"
+
+describe Greentext::Client do
+  it "has the api url set correctly" do
+    expect(@client.api_endpoint).to include("a.4cdn.org")
+  end
+end

data/spec/post_spec.rb

@@ -0,0 +1 @@
+require "spec_helper"

data/spec/spec_helper.rb

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

metadata

@@ -1,57 +1,71 @@
 --- !ruby/object:Gem::Specification
 name: greentext
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Avinash Dwarapu
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-04-20 00:00:00.000000000 Z
+date: 2014-04-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: faraday
+  name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.9'
+        version: '1.6'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.9'
+        version: '1.6'
 - !ruby/object:Gem::Dependency
   name: memoizable
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.4.2
+        version: '0.4'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.4.2
+        version: '0.4'
 - !ruby/object:Gem::Dependency
-  name: oj
+  name: faraday
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '0.9'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '0.9'
+- !ruby/object:Gem::Dependency
+  name: faraday_middleware
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
 - !ruby/object:Gem::Dependency
   name: rubocop
   requirement: !ruby/object:Gem::Requirement
@@ -139,8 +153,16 @@ files:
 - Rakefile
 - greentext.gemspec
 - lib/greentext.rb
+- lib/greentext/base.rb
+- lib/greentext/board.rb
 - 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
 licenses:
@@ -167,4 +189,7 @@ signing_key:
 specification_version: 4
 summary: Unofficial API for 4chan.
 test_files:
+- spec/board_spec.rb
+- spec/client_spec.rb
+- spec/post_spec.rb
 - spec/spec_helper.rb