trefoil 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: adc7d1dd5401c32dd327285a1ce3e19abcfadad43ccc6a0b77cd8fb84ef10fce
+  data.tar.gz: 4fe016b919392ce8b3c6cab0869f6ad8426a2b58926493411fc8a2e681a5d643
+SHA512:
+  metadata.gz: eb556fef835e6de55617d0ebe1a5208a8823caa847ea72d7cef592604092db83d4c6dcefc3bdb79921a5556f08e8f5c7fa6fc5d5e69466c169a84b5ef4b94c6f
+  data.tar.gz: f4e10541ee9e963e4bd80dfc973d08117fbc033e939945814d074747b188f64f63eb5d1f2ea9f50fc5d2643673c415ae2062d257fa5d6023d66040e81ff30739

data/.codeclimate.yml

@@ -0,0 +1,3 @@
+plugins:
+  rubocop:
+    enabled: true

data/.gitattributes

@@ -0,0 +1,2 @@
+# Auto detect text files and perform LF normalization
+* text=auto

data/.gitignore

@@ -0,0 +1,50 @@
+*.gem
+*.rbc
+/.config
+/coverage/
+/InstalledFiles
+/pkg/
+/spec/reports/
+/spec/examples.txt
+/test/tmp/
+/test/version_tmp/
+/tmp/
+
+# Used by dotenv library to load environment variables.
+# .env
+
+## Specific to RubyMotion:
+.dat*
+.repl_history
+build/
+*.bridgesupport
+build-iPhoneOS/
+build-iPhoneSimulator/
+
+## Specific to RubyMotion (use of CocoaPods):
+#
+# We recommend against adding the Pods directory to your .gitignore. However
+# you should judge for yourself, the pros and cons are mentioned at:
+# https://guides.cocoapods.org/using/using-cocoapods.html#should-i-check-the-pods-directory-into-source-control
+#
+# vendor/Pods/
+
+## Documentation cache and generated files:
+/.yardoc/
+/_yardoc/
+/doc/
+/rdoc/
+
+## Environment normalization:
+/.bundle/
+/vendor/bundle
+/lib/bundler/man/
+
+# for a library or gem, you might want to ignore these files since the code is
+# intended to run in multiple environments; otherwise, check them in:
+# Gemfile.lock
+# .ruby-version
+# .ruby-gemset
+
+# unless supporting rvm < 1.11.0 or doing something fancy, ignore this:
+.rvmrc

data/.rspec

@@ -0,0 +1 @@
+--require spec_helper -I lib

data/.rubocop.yml

@@ -0,0 +1,5 @@
+Metrics:
+  Enabled: false
+
+AllCops:
+  TargetRubyVersion: 2.3

data/.travis.yml

@@ -0,0 +1,3 @@
+language: ruby
+script:
+  - rake

data/Gemfile

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
+
+gemspec name: 'trefoil'

data/Gemfile.lock

@@ -0,0 +1,78 @@
+PATH
+  remote: .
+  specs:
+    trefoil (0.1.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    addressable (2.6.0)
+      public_suffix (>= 2.0.2, < 4.0)
+    ast (2.4.0)
+    crack (0.4.3)
+      safe_yaml (~> 1.0.0)
+    diff-lcs (1.3)
+    docile (1.3.1)
+    hashdiff (0.3.8)
+    jaro_winkler (1.5.2)
+    json (2.2.0)
+    parallel (1.14.0)
+    parser (2.6.0.0)
+      ast (~> 2.4.0)
+    powerpack (0.1.2)
+    psych (3.1.0)
+    public_suffix (3.0.3)
+    rainbow (3.0.0)
+    rake (12.3.2)
+    redcarpet (3.4.0)
+    rspec (3.8.0)
+      rspec-core (~> 3.8.0)
+      rspec-expectations (~> 3.8.0)
+      rspec-mocks (~> 3.8.0)
+    rspec-core (3.8.0)
+      rspec-support (~> 3.8.0)
+    rspec-expectations (3.8.2)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.8.0)
+    rspec-mocks (3.8.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.8.0)
+    rspec-support (3.8.0)
+    rubocop (0.65.0)
+      jaro_winkler (~> 1.5.1)
+      parallel (~> 1.10)
+      parser (>= 2.5, != 2.5.1.1)
+      powerpack (~> 0.1)
+      psych (>= 3.1.0)
+      rainbow (>= 2.2.2, < 4.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (~> 1.4.0)
+    ruby-progressbar (1.10.0)
+    safe_yaml (1.0.5)
+    simplecov (0.16.1)
+      docile (~> 1.1)
+      json (>= 1.8, < 3)
+      simplecov-html (~> 0.10.0)
+    simplecov-html (0.10.2)
+    unicode-display_width (1.4.1)
+    webmock (3.4.2)
+      addressable (>= 2.3.6)
+      crack (>= 0.3.2)
+      hashdiff
+    yard (0.9.18)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  rake (~> 12.0)
+  redcarpet (~> 3.4.0)
+  rspec (~> 3.8.0)
+  rubocop (~> 0.65)
+  simplecov (~> 0.16.0)
+  trefoil!
+  webmock (~> 3.4.0)
+  yard (~> 0.9.9)
+
+BUNDLED WITH
+   2.0.1

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2019 Matthew Carey
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

data/Rakefile

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+require 'bundler/gem_helper'
+require 'rspec/core/rake_task'
+require 'rubocop/rake_task'
+require 'yard'
+
+namespace :test do
+  desc 'Run specs'
+  RSpec::Core::RakeTask.new(:spec) do |t|
+    t.verbose = false
+  end
+
+  desc 'Run rubocop'
+  RuboCop::RakeTask.new(:rubocop)
+
+  task all: %i[spec rubocop]
+end
+
+task test: 'test:all'
+
+desc 'Generate yard docs'
+YARD::Rake::YardocTask.new do |t|
+  t.files = ['lib/**/*.rb']
+end
+
+desc 'alias for `yard`'
+task docs: :yard
+
+task default: :test

data/lib/trefoil/board.rb

@@ -0,0 +1,106 @@
+# frozen_string_literal: true
+
+module Trefoil
+  # Class representing a board. Used for requesting threads.
+  # A list of all ids can be found with `#threads`.
+  # An array of all active Threads can be obtained through `#catalog`.
+  # A list of archived thread ids can be found with `#archive.`
+  class Board
+    # @return [String] The name of the board being referenced.
+    attr_reader :name
+
+    def initialize(client, name)
+      @client = client
+      @name = name
+      @catalog = []
+    end
+
+    # Get info about this board. Keys based on `/boards.json`
+    # @param key [Symbol] The key to the desired data.
+    # @return [String, Integer, Hash<Symbol => Integer>, nil]
+    def [](key)
+      @client.send(:cache_boards) if board_cache.empty?
+      return nil unless board_cache[name]
+
+      board_cache[name][key]
+    end
+
+    # Whether or not this board is archived
+    # @return [true, false]
+    def archived?
+      self[:archived] == 1
+    end
+
+    # Whether or not this board is marked as not safe for work
+    # @return [true, false]
+    def nsfw?
+      self[:ws_board].zero?
+    end
+
+    # Gets a new thread by id.
+    # @param id [Integer] Thread id.
+    def thread(id)
+      Thread.new(client, self, id)
+    end
+
+    # Get a hash of threads and their last modified time
+    # @return [Hash<Integer => Integer>] A hash with thread ids as keys and their
+    #   last modified time as the corresponding value.
+    def threads
+      thread_list = {}
+      pages = @client.get("#{name}/threads.json")
+      pages.each do |page|
+        page[:threads].each do |thread|
+          thread_list[thread[:no]] = thread[:last_modified]
+        end
+      end
+
+      thread_list
+    end
+
+    # Retrive an array of archived thread ids.
+    # @return [Array<Integer>]
+    def archive
+      @client.get("#{name}/archive.json")
+    end
+
+    # Return a list of all active ops
+    # @return [Array<Hash<Symbol => Integer, String>>]
+    def catalog
+      return @catalog unless @catalog.empty?
+
+      update_catalog
+      @catalog
+    end
+
+    # Update the catalog with new ops
+    def update_catalog
+      @catalog = []
+      pages = @client.get("#{name}/catalog.json")
+      pages.each do |page|
+        page[:threads].each do |op|
+          @catalog << op
+        end
+      end
+    end
+
+    # Link to a board's custom spoiler
+    # @param int [Integer, nil] the custom spoiler id to use pics one randomly if left nil.
+    # @return [String, nil] The url to a spoiler, or nil if this board does not have custom spoilers.
+    def custom_spoiler(int = nil)
+      return nil unless self[:custom_spoilers]
+
+      spoiler_id = int || rand(self[:custom_spoilers]) + 1
+
+      "http://s.4cdn.org/image/spoiler-#{name}#{spoiler_id}.png"
+    end
+
+    private
+
+    # Proxy method for accessing the client's board cache
+    # @return [Hash<String => Hash<Symbol => String, Integer, Hash<String => Integer>>>]
+    def board_cache
+      @client.instance_variable_get(:@board_cache)
+    end
+  end
+end

data/lib/trefoil/client.rb

@@ -0,0 +1,80 @@
+# frozen_string_literal: true
+
+require 'json'
+require 'net/http'
+
+module Trefoil
+  # Client used for making requests to the API. Respects API rules for rate limiting
+  # and thread watching.
+  class Client
+    BASE_URL = 'a.4cdn.org'
+
+    # Initialize with a last_request time 1 second prior to present
+    # so that we can make requests right away
+    def initialize
+      @last_request = Time.now - 1
+      @mutex = Mutex.new
+      @board_cache = {}
+    end
+
+    # Get a JSON parsed response from a given endpoint. Limited to 1 request
+    # per second in compliance with API rules.
+    # @param endpoint [String] The endpoint to request data from.
+    # @return [Hash<Symbol => String, Fixnum>] The returned data structure
+    def get(endpoint)
+      @mutex.synchronize do
+        sleep time_until_available if must_wait?
+        resp = Net::HTTP.get_response(BASE_URL, format_endpoint(endpoint))
+        @last_request = Time.now
+        case resp.code.to_i
+        when 200
+          JSON.parse(resp.body, symbolize_names: true)
+        when 400..500
+          raise 'Error making a request' # TODO: Better error handling
+        else
+          raise 'Unhandled status code' # TODO: better code handling
+        end
+      end
+    end
+
+    # Get a board object based on its name
+    # @param board_name [String]
+    def board(board_name)
+      Board.new(self, board_name)
+    end
+
+    private
+
+    # Adds leading '/' to requests
+    # @param endpoint [String] The endpoint being formatted
+    # @return [String] `endpoint` with leading `/` added if needed
+    def format_endpoint(endpoint)
+      return endpoint if endpoint[0] == '/'
+
+      '/' + endpoint
+    end
+
+    # Amount of time before the mutex is freed for the next request
+    # @return [Fixnum, Float] Time remaining until the next request can be made
+    def time_until_available
+      (@last_request + 1) - Time.now
+    end
+
+    # Whether we must wait to make a request
+    # @return [true, false] Whether we need to wait or not
+    def must_wait?
+      time_until_available.positive?
+    end
+
+    # Cache boards from `/boards.json`. Called when accessing `Board#[]` for
+    # the first time. Effects last request time.
+    def cache_boards
+      boards = get('boards.json')
+      boards[:boards].each do |board_obj|
+        @board_cache[board_obj[:board]] = board_obj
+      end
+
+      @board_cache[:troll_flags] = boards[:troll_flags]
+    end
+  end
+end

data/lib/trefoil/image.rb

@@ -0,0 +1,86 @@
+# frozen_string_literal: true
+
+require 'trefoil/board'
+
+module Trefoil
+  # A class representing an Image using data from a post object.
+  class Image
+    # @return [Integer] Renamed filename (UNIX timestamp + miliseconds)
+    attr_reader :tim
+
+    # @return [String] Original filename of this image
+    attr_reader :filename
+
+    # @return [String] File extension of the fullsize image.
+    attr_reader :ext
+
+    # @return [Integer] Filesize of the fullsize image.
+    attr_reader :fsize
+
+    # @return [String] MD5 hash of fullsize image.
+    attr_reader :md5
+
+    # @return [Integer] Width of fullsize image.
+    attr_reader :w
+
+    # @return [Integer] Height of fullsize image.
+    attr_reader :h
+
+    # @return [Integer] Width of thumbnail.
+    attr_reader :tn_w
+
+    # @return [Integer] Height of thumbnail.
+    attr_reader :tn_h
+
+    # @return [0, 1, nil] Whether this image is deleted. Use `#image?` for a boolean representation.
+    attr_reader :filedeleted
+
+    # @return [0, 1, nil] Whether this image is a spoiler. Use `#spoiler?` for a boolean representation.
+    attr_reader :spoiler
+
+    # @return [String] The name of the board this image is associated with.
+    attr_reader :board_name
+
+    # Create a new image object. Intended for internal use.
+    # @param data [Hash<Symbol => Integer, String] Data from a post object to extrapolate info from.
+    # @param board [Board, String] The board, or board name, associated with the post this image is from.
+    def initialize(data, board)
+      expand_data(data)
+      @board_name = board.is_a?(Board) ? board[:name] : board
+    end
+
+    # The url to the full size image.
+    # @return [String] url to the fullsize version of this image.
+    def url
+      "http://i.4cdn.org/#{board_name}/#{tim}#{ext}"
+    end
+
+    # The url to the thumbnail of this image.
+    # @return [String] url to the thumbnail of this image.
+    def thumbnail_url
+      "http://i.4cdn.org/#{board_name}/#{tim}s.jpg"
+    end
+
+    # Convenience abstraction for determining if this file was deleted.
+    # @return [true, false] Whether this file was deleted.
+    def file_deleted?
+      filedeleted == 1
+    end
+
+    # Convenience abstraction for determining if this file is a spoiler.
+    # @return [true, false] Whether this file is a spoiler.
+    def spoiler?
+      spoiler == 1
+    end
+
+    private
+
+    # Move desired values from post data into instance variables.
+    # @param data [Hash<Symbol => Integer, String] Data from a Post object.
+    def expand_data(data)
+      %i[tim filename ext fsize md5 w h tn_w tn_h filedeleted spoiler].each do |sym|
+        instance_variable_set("@#{sym}", data[sym])
+      end
+    end
+  end
+end

data/lib/trefoil/post.rb

@@ -0,0 +1,66 @@
+# frozen_string_literal: true
+
+module Trefoil
+  # Represents a `post` object.
+  # Post object data varies greatly based on board, content, and whether it is an OP.
+  # Possible fields are available for viewing in the (API documentation)[https://github.com/4chan/4chan-API#posts-object]
+  class Post
+    # Intended for internal use
+    def initialize(client, board, thread, data)
+      @client = client
+      @board = board
+      @thread = thread
+      @data = data
+    end
+
+    # Access underlying post data with symbolized names
+    # Possible fields are available for viewing in the (API documentation)[https://github.com/4chan/4chan-API#posts-object]
+    # @param key [Symbol] The API field
+    # @return [Hash, Array, String, Fixnum]
+    def [](key)
+      @data[key]
+    end
+
+    # Whether this is the first post in a thread. All op's has a resto of 0
+    # @return [true, false]
+    def op?
+      @data[:resto].zero?
+    end
+
+    # Whether this post has an image associated with it
+    # @return [true, false]
+    def image?
+      !@data[:filename].is_nil?
+    end
+
+    # Url to the image of this post, if any.
+    # @return [Image, nil] An Image or nil if no image is present.
+    def image_url
+      return nil unless image?
+
+      Image.new(@data)
+    end
+
+    # Url to this post
+    # @return [String] The url to this post.
+    def url
+      direct_link = if @data[:resto].zero?
+                      @data[:no]
+                    else
+                      "#{@data[:resto]}p##{@data[:no]}"
+                    end
+
+      "http://boards.4chan.org/#{@board}/thread/#{direct_link}"
+    end
+
+    # The OP to the thread this post is in.
+    # @return [Post] A post object for the OP, the instance it was called on if it is the OP.
+    def op
+      if @data[:resto].zero
+        self
+      else
+        thread.posts[0]
+      end
+    end
+  end
+end

data/lib/trefoil/thread.rb

@@ -0,0 +1,47 @@
+# frozen_string_literal: true
+
+module Trefoil
+  # Represents an array of Post objects with additional convenience methods
+  class Thread
+    def initialize(client, board, id)
+      @client = client
+      @board = board
+      @id = id
+      @posts = nil
+    end
+
+    # Get a post based on its position
+    # @param index [Integer] the index of the desired post
+    # @return [Post, nil] A post object or nil if out of bounds.
+    def [](index)
+      posts[index]
+    end
+
+    # An array of all posts in the thread
+    # @return [Array<Post>] All posts in this thread since last update
+    def posts
+      @posts = fetch_posts if @posts.nil?
+      @posts
+    end
+
+    # Convenience method to get the first post in a thread
+    # @return [Post]
+    def op
+      posts[0]
+    end
+
+    # Refresh post list
+    def update
+      fetch_posts
+    end
+
+    private
+
+    # Fetch all posts into
+    def fetch_posts
+      @client.get("/#{@board}/thread/#{@id}.json")[:posts].each do |post|
+        @posts << Post.new(@client, @board, self, post)
+      end
+    end
+  end
+end

data/lib/trefoil/version.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+# Trefoil container module
+module Trefoil
+  # Trefoil version number
+  VERSION = '0.1.0'
+end

data/lib/trefoil.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+require 'trefoil/board'
+require 'trefoil/client'
+require 'trefoil/image'
+require 'trefoil/post'
+require 'trefoil/thread'

data/trefoil.gemspec

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+lib = File.expand_path('lib', __dir__)
+$LOAD_PATH.unshift lib
+
+require 'trefoil/version'
+
+Gem::Specification.new do |s|
+  s.name = 'trefoil'
+  s.version = Trefoil::VERSION
+  s.authors = ['swarley']
+  s.email = ['matthew.b.carey@gmail.com']
+
+  s.summary = '4chan Public API Client'
+  s.description = 'A client for accessing the 4chan public api.'
+  s.homepage = 'https://github.com/swarley/trefoil-rb'
+  s.license = 'MIT'
+
+  s.files = `git ls-files -z`.split(?\x0).reject do |f|
+    f =~ /^(spec|doc|examples)/
+  end
+  s.require_paths = ['lib']
+
+  s.add_development_dependency 'rake', '~> 12.0'
+  s.add_development_dependency 'rspec', '~> 3.8.0'
+  s.add_development_dependency 'rubocop', '~> 0.65'
+  s.add_development_dependency 'webmock', '~> 3.4.0'
+  s.add_development_dependency 'yard', '~> 0.9.9'
+end

metadata

@@ -0,0 +1,132 @@
+--- !ruby/object:Gem::Specification
+name: trefoil
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- swarley
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2019-03-09 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '12.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '12.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.8.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.8.0
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.65'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.65'
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.4.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.4.0
+- !ruby/object:Gem::Dependency
+  name: yard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.9.9
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.9.9
+description: A client for accessing the 4chan public api.
+email:
+- matthew.b.carey@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".codeclimate.yml"
+- ".gitattributes"
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- ".travis.yml"
+- Gemfile
+- Gemfile.lock
+- LICENSE
+- Rakefile
+- lib/trefoil.rb
+- lib/trefoil/board.rb
+- lib/trefoil/client.rb
+- lib/trefoil/image.rb
+- lib/trefoil/object.rb
+- lib/trefoil/post.rb
+- lib/trefoil/thread.rb
+- lib/trefoil/version.rb
+- trefoil.gemspec
+homepage: https://github.com/swarley/trefoil-rb
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.0.1
+signing_key: 
+specification_version: 4
+summary: 4chan Public API Client
+test_files: []