bocu 0.3.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: c2cda24473af47b1835505dbdd4b56b7df8ff6cc
+  data.tar.gz: 34c09ea55b27719089d6b59c2889345f0f1c8a3e
+SHA512:
+  metadata.gz: 6fb3771d6242d02604b49e517558a5646df2ebc1224cc3a2091bc48529c6d871dd556bb143b23b495b9c41c3c487fe2cfe8a71edf91ec44c652f49ee28fe9488
+  data.tar.gz: '0719772c9a9b4967c51572ac29f803f4acc8a878b759c39fad612c6d80bb6a06d98923a287f2d87a288b4549e51205171c0bc79af0aaf0c1a0467c6cdebf870b'

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.rubocop.yml

@@ -0,0 +1,35 @@
+AllCops:
+  TargetRubyVersion: 2.3
+  Exclude:
+    - '.bundle/**/*'
+    - 'bin/**/*'
+    - 'config/**/*'
+    - 'db/**/*'
+    - 'lib/tasks/**/*'
+    - 'app/controllers/users/confirmations_controller.rb'
+    - 'app/controllers/users/registrations_controller.rb'
+    - 'lib/extensions/simple_form/inputs/array_input.rb'
+    - 'vendor/assets/**/**/*'
+    - 'spec/factories/**/*'
+
+Documentation:
+  Enabled: false
+
+Metrics/LineLength:
+  Max: 110
+
+Style/SymbolArray:
+  Enabled: true
+
+Style/FrozenStringLiteralComment:
+  Enabled: false
+
+Style/RedundantFreeze:
+  Enabled: false
+
+Metrics/AbcSize:
+  Exclude:
+    - 'test/**/*'
+
+Lint/AmbiguousBlockAssociation:
+  Enabled: false

data/.travis.yml

@@ -0,0 +1,4 @@
+language: ruby
+rvm:
+  - 2.4.1
+before_install: gem install bundler

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in bocu.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Emil Shakirov
+
+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/README.md

@@ -0,0 +1,102 @@
+# Bocu
+![](https://lh6.ggpht.com/FEPLCErGsrB4ErBdbtKaZfDq6df3Od2-g0kA8soEi3TdiuSYAhqSn4I87IYs1blzpd0=w300)
+
+[![Build Status](https://travis-ci.org/vaihtovirta/bocu.svg?branch=master)](https://travis-ci.org/vaihtovirta/bocu)
+
+API wrapper for [Coub](http://coub.com)
+
+Powered by [Her](https://github.com/remiprev/her) — ORM for REST API.
+
+Currently under development, so it supports only several public API methods.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'bocu'
+```
+
+## Usage
+
+You can check official Coub API docs [here](http://coub.com/dev/docs/Coub+API/Overview).
+
+##### Search by query:
+
+```ruby
+require 'bocu'
+
+coubs = Bocu::Coub.search('optimism')
+coubs = coubs.order_by(:likes_count).page(5).per(25).fetch
+# returns array of coubs, wrapped with Her::Model
+
+coubs.first.attributes
+# => returns Big Coub JSON, most part is omitted
+# => {"flag"=>nil, "abuses"=>nil, "recoubs_by_users_channels"=>nil,
+# "recoub"=>nil, "like"=>nil, "in_my_best2015"=>false,
+# "type"=>"Coub::Simple", "permalink"=>"5kirj"...
+```
+
+##### Search by id:
+
+```ruby
+require 'bocu'
+
+coub = Bocu::Coub.find('70x8c')
+# => returns Big Coub JSON, most part is omitted
+# => #<Bocu::Coub(coubs/12553778) flag=nil abuses=nil recoubs_by_users_channels=nil recoub=nil like=nil
+# in_my_best2015=false type="Coub::Simple" permalink="70x8c" title="House Every Weekend"
+# visibility_type="public" original_visibility_type="public" channel_id=1162114
+# created_at="2015-06-26T04:24:28Z" updated_at="2017-07-10T03:56:43Z" ...
+```
+
+##### Timeline:
+
+[Related docs](https://coub.com/dev/docs/Coub+API/Timelines)
+
+```ruby
+require 'bocu'
+
+Bocu::Coub.by_tag('games').fetch # coubs by tag
+Bocu::Coub.hot.fetch # timeline of the Hot section
+
+# timeline of the Explore section categories
+Bocu::Coub.random.fetch
+Bocu::Coub.newest.fetch
+Bocu::Coub.coub_of_the_day.fetch
+```
+
+##### Using chainable scopes for pagination and ordering:
+
+```ruby
+require 'bocu'
+
+coubs = Bocu::Coub.search('drive')
+coubs = coubs.order_by(:views_count).per_page(5).page(2)
+
+result = coubs.fetch # Returns array of 5 hot coubs starting from page 2
+result.metadata # {:page=>"2", :total_pages=>504, :per_page=>"5"}
+result.count # 5
+```
+
+## TODO
+
+- Improve documentaion
+- More tests
+- More supported methods
+- Authentication(?)
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/vaihtovirta/bocu.
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,10 @@
+require 'bundler/gem_tasks'
+require 'rake/testtask'
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'test'
+  t.libs << 'lib'
+  t.test_files = FileList['test/**/*_test.rb']
+end
+
+task default: :test

data/bocu.gemspec

@@ -0,0 +1,41 @@
+# coding: utf-8
+
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'bocu/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'bocu'
+  spec.version       = Bocu::VERSION
+  spec.authors       = ['Emil Shakirov']
+  spec.email         = ['5o.smoker@gmail.com']
+
+  spec.summary       = 'Ruby wrapper for coub.com API'
+  spec.description   = 'Ruby wrapper for coub.com API'
+  spec.homepage      = 'https://github.com/vaihtovirta/bocu'
+  spec.license       = 'MIT'
+
+  # Prevent pushing this gem to RubyGems.org by setting 'allowed_push_host', or
+  # delete this section to allow pushing this gem to any host.
+  if spec.respond_to?(:metadata)
+    spec.metadata['allowed_push_host'] = 'https://rubygems.org'
+  else
+    raise 'RubyGems 2.0 or newer is required to protect against public gem pushes.'
+  end
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = 'exe'
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  spec.add_development_dependency 'bundler', '~> 1.14'
+  spec.add_development_dependency 'minitest-vcr', '~> 1.4'
+  spec.add_development_dependency 'minitest', '~> 5.10'
+  spec.add_development_dependency 'pry', '~> 0.10'
+  spec.add_development_dependency 'rake', '~> 12'
+  spec.add_development_dependency 'vcr', '~> 3'
+  spec.add_development_dependency 'webmock', '~> 3'
+  spec.add_development_dependency 'simplecov', '~> 0.10'
+
+  spec.add_runtime_dependency 'her', '~> 0.9'
+end

data/lib/bocu.rb

@@ -0,0 +1,9 @@
+require 'bocu/configuration'
+require 'bocu/version'
+
+module Bocu
+  SEARCH_ENDPOINT = 'search'.freeze
+  TIMELINE_ENDPOINT = 'timeline'.freeze
+
+  extend Bocu::Configuration
+end

data/lib/bocu/concerns/common_scopes.rb

@@ -0,0 +1,14 @@
+require 'active_support/concern'
+
+module Bocu
+  module CommonScopes
+    extend ActiveSupport::Concern
+
+    included do
+      scope :order_by, ->(order_by) { where(order_by: order_by) }
+      scope :page_of, ->(order_by) { where(page_of: order_by) }
+      scope :page, ->(page_number) { where(page: page_number) }
+      scope :per_page, ->(per_page_quantity) { where(per_page: per_page_quantity) }
+    end
+  end
+end

data/lib/bocu/configuration.rb

@@ -0,0 +1,39 @@
+require 'her'
+require 'bocu/middleware/parser'
+require 'bocu/concerns/common_scopes'
+
+module Bocu
+  module Configuration
+    DEFAULT_ENDPOINT = 'http://coub.com/api/v2'.freeze
+
+    class << self
+      def extended(_mod)
+        configure
+      end
+
+      def configure
+        setup_her
+        require_models
+      end
+
+      private
+
+      def require_models
+        require 'bocu/timelines/explore'
+        require 'bocu/timelines/hot'
+        require 'bocu/timelines/tag'
+        require 'bocu/coub'
+        require 'bocu/search'
+      end
+
+      def setup_her
+        Her::API.setup url: DEFAULT_ENDPOINT do |connection|
+          connection.use Faraday::Request::UrlEncoded
+          connection.use Bocu::Middleware::Parser
+          connection.use Faraday::Adapter::NetHttp
+          connection.use Faraday::Response::Logger
+        end
+      end
+    end
+  end
+end

data/lib/bocu/coub.rb

@@ -0,0 +1,27 @@
+module Bocu
+  class Coub
+    include Her::Model
+    include CommonScopes
+
+    class << self
+      def search(query)
+        Search.with_query(query)
+      end
+
+      def by_tag(tag_name)
+        Bocu::Timelines::Tag.by_tag(tag_name)
+      end
+
+      def hot
+        Bocu::Timelines::Hot.all
+      end
+
+      # definition of coub_of_the_day, newest, random methods
+      Bocu::Timelines::Explore::CATEGORIES.each do |category|
+        define_method category do
+          Timelines::Explore.send(category)
+        end
+      end
+    end
+  end
+end

data/lib/bocu/middleware/parser.rb

@@ -0,0 +1,28 @@
+module Bocu
+  module Middleware
+    class Parser < Faraday::Response::Middleware
+      DATA_KEYS = %i[coubs channels].freeze
+
+      def on_complete(env)
+        env[:body] = parse(env[:body])
+      end
+
+      private
+
+      def includes_data_keys?(json)
+        (json.keys & DATA_KEYS).any?
+      end
+
+      def parse(body)
+        json = parsed_json(body)
+        metadata = json.slice!(*DATA_KEYS) if includes_data_keys?(json)
+
+        { data: json, metadata: metadata || {} }
+      end
+
+      def parsed_json(body)
+        MultiJson.load(body, symbolize_keys: true)
+      end
+    end
+  end
+end

data/lib/bocu/search.rb

@@ -0,0 +1,11 @@
+module Bocu
+  class Search
+    include Her::Model
+    include CommonScopes
+
+    collection_path Bocu::SEARCH_ENDPOINT
+    parse_root_in_json :coubs, format: :active_model_serializers
+
+    scope :with_query, ->(query) { where(q: query) }
+  end
+end

data/lib/bocu/timelines/explore.rb

@@ -0,0 +1,15 @@
+module Bocu
+  module Timelines
+    class Explore
+      include Her::Model
+      include CommonScopes
+
+      CATEGORIES = %i[coub_of_the_day newest random].freeze
+
+      collection_path "#{Bocu::TIMELINE_ENDPOINT}/explore/:category_id"
+      parse_root_in_json :coubs, format: :active_model_serializers
+
+      CATEGORIES.each { |category| scope category, -> { where(category_id: category) } }
+    end
+  end
+end

data/lib/bocu/timelines/hot.rb

@@ -0,0 +1,11 @@
+module Bocu
+  module Timelines
+    class Hot
+      include Her::Model
+      include CommonScopes
+
+      collection_path "#{Bocu::TIMELINE_ENDPOINT}/hot"
+      parse_root_in_json :coubs, format: :active_model_serializers
+    end
+  end
+end

data/lib/bocu/timelines/tag.rb

@@ -0,0 +1,13 @@
+module Bocu
+  module Timelines
+    class Tag
+      include Her::Model
+      include CommonScopes
+
+      collection_path "#{Bocu::TIMELINE_ENDPOINT}/tag/:tag_name"
+      parse_root_in_json :coubs, format: :active_model_serializers
+
+      scope :by_tag, ->(tag_name) { where(tag_name: tag_name) }
+    end
+  end
+end

data/lib/bocu/version.rb

@@ -0,0 +1,3 @@
+module Bocu
+  VERSION = '0.3.0'.freeze
+end

metadata

@@ -0,0 +1,189 @@
+--- !ruby/object:Gem::Specification
+name: bocu
+version: !ruby/object:Gem::Version
+  version: 0.3.0
+platform: ruby
+authors:
+- Emil Shakirov
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2017-08-04 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.14'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.14'
+- !ruby/object:Gem::Dependency
+  name: minitest-vcr
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.4'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.4'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.10'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.10'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '12'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '12'
+- !ruby/object:Gem::Dependency
+  name: vcr
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3'
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.10'
+- !ruby/object:Gem::Dependency
+  name: her
+  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'
+description: Ruby wrapper for coub.com API
+email:
+- 5o.smoker@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rubocop.yml"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bocu.gemspec
+- lib/bocu.rb
+- lib/bocu/concerns/common_scopes.rb
+- lib/bocu/configuration.rb
+- lib/bocu/coub.rb
+- lib/bocu/middleware/parser.rb
+- lib/bocu/search.rb
+- lib/bocu/timelines/explore.rb
+- lib/bocu/timelines/hot.rb
+- lib/bocu/timelines/tag.rb
+- lib/bocu/version.rb
+homepage: https://github.com/vaihtovirta/bocu
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+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: []
+rubyforge_project: 
+rubygems_version: 2.6.11
+signing_key: 
+specification_version: 4
+summary: Ruby wrapper for coub.com API
+test_files: []