pornhub_api 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5206447ec5c769953fe4428c15e4cac0b25bf72b1a26e92f8e0ae43d94e43fc7
-  data.tar.gz: b2064db42fe677409f0cfd8d7e299e4a79ec36f5cdaf2c435bdd031c484ab19a
+  metadata.gz: 64e6d91b7c12e3b9e23a89d73ac06a4be3c09596e06618e8767e5fe652313c90
+  data.tar.gz: b2a28225e86b673ec52d31280603e8654c4c687cb4c879f4f5703140388554c9
 SHA512:
-  metadata.gz: 89ca84eefae8f71f76b0010b9b2ee88463c5010bd966df5eb28cfc430149d45899af323734c0ffab8808b5dfa50f4e0a2d9bfa6421e2a27ef83dd557b545cbdb
-  data.tar.gz: 0c105502f45328b099d6d8cb15f6a83dab37d13d46a54ed92fca751ca342a5dac21d6a139021f83d4446d3230a1f6cb14d209e20f485158f7a942c147b179876
+  metadata.gz: 496ee9930a9d27037b937a677046746ab98edd7a88d8d02d2eb000f8117425cb9d81bdba714dce8b54ba23ed3b2e79c103a4cacb684e4c57b871d0e3b69746eb
+  data.tar.gz: b7a724d9a64cdfd7195db23c77fafcebc8874dacb776d9932975d0cdd7624be355e8b2ce020369d42e4dfa6835155429f46467b9b81195bc3e08efa1b01f5b6f

data/.github/workflows/gem-push.yml

@@ -0,0 +1,29 @@
+name: Ruby Gem
+
+on:
+  push:
+    tags:
+      - 'v*.*.*'
+
+jobs:
+  build:
+    name: Build + Publish
+    runs-on: ubuntu-latest
+
+    steps:
+    - uses: actions/checkout@v2
+    - name: Set up Ruby 2.7
+      uses: actions/setup-ruby@v1
+      with:
+        ruby-version: '2.7'
+
+    - name: Publish to RubyGems
+      run: |
+        mkdir -p $HOME/.gem
+        touch $HOME/.gem/credentials
+        chmod 0600 $HOME/.gem/credentials
+        printf -- "---\n:rubygems_api_key: ${GEM_HOST_API_KEY}\n" > $HOME/.gem/credentials
+        gem build *.gemspec
+        gem push *.gem
+      env:
+        GEM_HOST_API_KEY: "${{secrets.RUBYGEMS_AUTH_TOKEN}}"

data/.rubocop.yml

@@ -15,3 +15,6 @@ Layout/LineLength:
 Metrics/BlockLength:
   Exclude:
     - spec/**/*
+
+Style/AsciiComments:
+  Enabled: false

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2020 Kirill Bobykin
+
+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

@@ -1,7 +1,31 @@
 # PornhubApi
 
+[![Gem Version](https://badge.fury.io/rb/pornhub_api.svg)](https://badge.fury.io/rb/pornhub_api)
+
 Simple Pornhub API client
 
+Please check [documentation](https://rubydoc.info/gems/pornhub_api/PornhubApi) and [schemas](spec/schemas) to explore
+possible responses
+
+```ruby
+require 'pornhub_api'
+
+# the simplest call 
+PornhubApi.search
+
+# adjust your search
+PornhubApi.search(search: 'lana rhoades', thumbsize: 'small', ordering: 'mostviewed')
+
+# All possible methods
+PornhubApi.search
+PornhubApi.stars
+PornhubApi.stars_detailed
+PornhubApi.video_by_id(id: 'ph5f59beb3df90a')
+PornhubApi.is_video_active(id: 'ph5f59beb3df90a')
+PornhubApi.categories
+PornhubApi.tags(list: 'a')
+```
+
 ## Installation
 
 Add this line to your application's Gemfile:
@@ -18,16 +42,15 @@ Or install it yourself as:
 
     $ gem install pornhub_api
 
-## Usage
-
-```ruby
-PornhubApi.search
-```
-
 ## Development
 
-After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. 
+You can also run `bin/console` for an interactive prompt that will allow you to experiment.
 
 ## Contributing
 
 Bug reports and pull requests are welcome on GitHub at https://github.com/qelphybox/pornhub_api.
+
+## Roadmap
+    - Binary executable file
+    - News RSS feed requests

data/lib/pornhub_api.rb

@@ -11,32 +11,96 @@ module PornhubApi
   class Error < StandardError; end
 
   class << self
-    BASE_URI = URI("https://rt.pornhub.com")
+    BASE_URI = URI("https://www.pornhub.com")
 
     # Search pornhub videos
     # @param [Hash] options
     # @option options [String] :search Search query
     # @option options [Integer] :page Page number
-    # @option options [String] :thumbsize Possible values are small,medium,large,small_hd,medium_hd,large_hd
+    # @option options [String] :thumbsize Possible values are small, medium, large, small_hd, medium_hd, large_hd
     # @option options [String] :category The subject
     # @option options [String] :ordering Possible values are featured, newest, mostviewed and rating
     # @option options [Array] :phrase Used as pornstars filter.
     # @option options [Array] :tags The email's body
-    # @option options [String] :period Only works with ordering parameter.
-    #                                  Possible values are weekly, monthly, and alltime
+    # @option options [String] :period Works ith ordering Possible values are weekly, monthly, and alltime
     # @return [Object] response
+    #
+    # ==== Example Request video search
+    # PornhubApi.search # =>
+    # {
+    #     "videos": [
+    #         {
+    #             "duration": "11:20",
+    #             "views": 2597,
+    #             "video_id": "ph5e7cddd1b610e",
+    #             "rating": "81.8182",
+    #             "ratings": 22,
+    #             "title": "Young babe Anna fed cum after anal banging and blowjob",
+    #             "url": "https://www.pornhub.com/view_video.php?viewkey=ph5e7cddd1b610e",
+    #             "default_thumb": "https://di.phncdn.com/videos/202003/26/296992831/original/(m=eaf8Ggaaaa)",
+    #             "thumb": "https://di.phncdn.com/videos/202003/26/296992831/original/(m=eaf8Ggaaaa)13.jpg",
+    #             "publish_date": "2020-12-26 12:10:17",
+    #             "thumbs": [
+    #                 {
+    #                     "size": "320x240",
+    #                     "width": "320",
+    #                     "height": "240",
+    #                     "src": "https://di.phncdn.com/videos/202003/26/296992831/original/(mh=_Tyqk2i6XofP-YRe)1.jpg"
+    #                 }
+    #             ],
+    #             "tags": [
+    #                 { "tag_name": "hotbabes4k" }
+    #             ],
+    #             "pornstars": [
+    #                { "pornstar_name": "Sheena Ryder" }
+    #             ],
+    #             "categories": [
+    #                 { "category": "babe" },
+    #             ],
+    #             "segment": "straight"
+    #         },
+    #     ]
+    # }
     def search(**options)
       webmasters_request("search", options)
     end
 
     # Get pornstars list
     # @return [Object] response
+    #
+    # ==== Example
+    # PornhubApi.stars # =>
+    # {
+    #     "stars": [
+    #         {
+    #             "star": {
+    #                 "star_name": " Vixxen Goddess"
+    #             }
+    #         }
+    #     ]
+    # }
     def stars
       webmasters_request("stars")
     end
 
     # Get detailed pornstars list
     # @return [Object] response
+    #
+    # ==== Example
+    # PornhubApi.stars_detailed # =>
+    # {
+    #     "stars": [
+    #         {
+    #             "star": {
+    #                 "star_name": " Melisa Wide",
+    #                 "star_thumb": "https://di.phncdn.com/pics/pornstars/default/(m=lciuhScOb_c)female.jpg",
+    #                 "star_url": "https://www.pornhub.com/pornstar/videos_overview?pornstar=melisa-wide",
+    #                 "gender": "female",
+    #                 "videos_count_all": "0"
+    #             }
+    #         },
+    #     ]
+    # }
     def stars_detailed
       webmasters_request("stars_detailed")
     end
@@ -44,28 +108,101 @@ module PornhubApi
     # Get video by id
     # @param [Object] id Video id
     # @param [Hash] options
-    # @option options []
+    # @option options [String] thumbsize Possible values are small, medium, large, small_hd, medium_hd, large_hd
     # @return [Object] response
+    #
+    # ==== Example
+    #
+    # PornhubApi.video_by_id(id: 'ph5f59beb3df90a') # =>
+    # {
+    #   "video": {
+    #     "duration": "0:04",
+    #     "views": 2,
+    #     "video_id": "ph5f59beb3df90a",
+    #     "rating": 0,
+    #     "ratings": 0,
+    #     "title": "Dick stroke",
+    #     "url": "https://www.pornhub.com/view_video.php?viewkey=ph5f59beb3df90a",
+    #     "default_thumb": "https://ei.phncdn.com/videos/202009/10/350564541/original/(m=eaf8Ggaaaa)12.jpg",
+    #     "thumb": "https://ei.phncdn.com/videos/202009/10/350564541/original/(m=eaf8Ggaaaa)13.jpg",
+    #     "publish_date": "2020-12-26 22:44:47",
+    #     "thumbs": [
+    #       {
+    #         "size": "320x240",
+    #         "width": "320",
+    #         "height": "240",
+    #         "src": "https://ei.phncdn.com/videos/202009/10/350564541/original/(m=eaf8Ggaaaa)15.jpg"
+    #       }
+    #     ],
+    #     "tags": [
+    #       {
+    #         "tag_name": "big cock"
+    #       }
+    #     ],
+    #     "pornstars": [],
+    #     "categories": [
+    #       {
+    #         "category": "amateur"
+    #       }
+    #     ],
+    #     "segment": "straight"
+    #   }
+    # }
     def video_by_id(id:, **options)
       webmasters_request("video_by_id", { id: id, **options })
     end
 
+    # Get video activeness
     # @param [Object] id Video id
     # @param [Hash] options
     # @return [Object] response
     # rubocop:disable Naming/PredicateName
+    #
+    # ==== Example
+    # PornhubApi.is_video_active(id: 'ph5f59beb3df90a') # =>
+    # {
+    #     "active": {
+    #         "video_id": "ph5f59beb3df90a",
+    #         "is_active": "1"
+    #     }
+    # }
     def is_video_active(id:, **options)
       webmasters_request("is_video_active", { id: id, **options })
     end
     # rubocop:enable Naming/PredicateName
 
+    # Get all categories
     # @return [Object] response
+    # PornhubApi.categories # =>
+    # {
+    #   "categories": [
+    #     {
+    #       "id": "139",
+    #       "category": "verified-models"
+    #     }
+    #   ]
+    # }
     def categories
       webmasters_request("categories")
     end
 
+    # Get all tags by first char
     # @param [Object] list
     # @return [Object] response
+    # PornhubApi.tags(list: 'a') # =>
+    # {
+    #   "warning": "We had to change the response structure due to high amount of tags. Please adjust your code",
+    #   "tagsCount": 283196,
+    #   "tags": [
+    #     "płąnący",
+    #     "płaska",
+    #     "płaszcz",
+    #     "płaszczyk",
+    #     "pławska",
+    #     "płock",
+    #     "płonę"
+    #   ]
+    # }
     def tags(list:)
       webmasters_request("tags", { list: list })
     end
@@ -77,6 +214,8 @@ module PornhubApi
       uri.query = URI.encode_www_form(options)
       response = Net::HTTP.get_response(uri)
       JSON.parse(response.body, symbolize_names: true)
+    rescue Errno::ECONNREFUSED, SocketError => e
+      raise Error, e
     end
   end
 end

data/lib/pornhub_api/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module PornhubApi
-  VERSION = "0.1.0"
+  VERSION = "0.1.1"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: pornhub_api
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - Kirill Bobykin
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-12-26 00:00:00.000000000 Z
+date: 2020-12-27 00:00:00.000000000 Z
 dependencies: []
 description: Simple Pornhub API client
 email:
@@ -17,11 +17,13 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".github/workflows/gem-push.yml"
 - ".github/workflows/main.yml"
 - ".gitignore"
 - ".rspec"
 - ".rubocop.yml"
 - Gemfile
+- LICENSE
 - README.md
 - Rakefile
 - bin/console
@@ -49,7 +51,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.2
+rubygems_version: 3.1.4
 signing_key: 
 specification_version: 4
 summary: Pornhub API client