syobocalite 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: f8dcc7caf5e785e5db9e1a125e3a6ae293649e8e1d8b1147f02be88765a37603
+  data.tar.gz: ec89b3bc62616e1410eef439ab5618bd1bb4a6bd60d738cf02dba81a99e8eb44
+SHA512:
+  metadata.gz: 4bffe23133dbd2af590cc510e9853e2c24ed082bc58b8627a27134fbd1caac3e83197b0efeb4d628e363bc699fc5509cd63eacd675e025437e8dff0ff5498e9d
+  data.tar.gz: 7e35926344c57137a133463649dc2285b64ee85fd1aa051a32fb4c4e2d2fa1ee99a88c83703d7a7201de4b0a32405ed9f3f617b1b6cee1550cf3cbc1dbc86472

data/.coveralls.yml

@@ -0,0 +1 @@
+repo_token: 2UFIIAxPxVPLjinaP0ZRXnY4SARkXc7PP

data/.gitignore

@@ -0,0 +1,13 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status
+
+Gemfile.lock

data/.rspec

@@ -0,0 +1,3 @@
+--format progress
+--color
+--require spec_helper

data/.travis.yml

@@ -0,0 +1,26 @@
+language: ruby
+rvm:
+- 2.3
+- 2.4
+- 2.5
+- ruby-head
+bundler_args: "--jobs=4"
+cache: bundler
+before_install:
+- gem update --system --no-document
+- gem install bundler --no-document
+before_script:
+- export CODECLIMATE_REPO_TOKEN=82d5b98775f7517294816845556790951867aba59db59a59178f0bed50a44216
+script:
+- bundle exec rspec
+# - bundle exec codeclimate-test-reporter || true
+branches:
+  only:
+  - master
+matrix:
+  allow_failures:
+  - rvm: ruby-head
+sudo: false
+notifications:
+  slack:
+    secure: GZZkyEmKBlwECsm47m+8XOcQhNcXciPsUhXfrAFBfTRxwCCy7myUBXL7aSV9T10N+QQX1rVilkD1zHRgX3U2S/S8xQfafrYiv5ZNDXp6xrNqGPC3WNGGY9PzvhJxpacp05qXxWXR5ml3Uk+1IZIoWJIPNtUVAgVO2gg6eLegHMiR2DwFmylW3nbfY6ozb6lo00rBih/k8KFqKZwo7odbdWN5LMPPH5vzO2f3sTF/3F8KsgxhESoA9hBLymDlcofEJ0gThXIH0T1WQGRmPpjJu5CSt5DAgDJxoJ/DjHy02ZJi/2vy8WnM2TGNI0sGInp/0GYb8AntpnyDw57UF2MCW4pYBqVgGfUxRHunzhLTtUI870BrQN0UHzHvnMgyxXCLZYN7rMqBuptQXRseWXzWovDHBEeGtYaEf41aOCX9bi/KC+k4FEeK6eJIXW5FXBC6TOnQTYvCx1V2BDdqH2jzxfSEtyA7rJlzDr+CajfsT25H+izqUQF7s5JxtcPuYoHXfxN420Qpfylvmje312WnccKXQKqdX4K/MWy+PM2VsU74EWCUy52flMonqKblyPWGn+Eo4LxGGRkq68lzVH02fwlF9QiIX0jjFkLPyHrw2+kxDK4g2S5+VxIOsKq2IYssXuEfGlXHuv3TRLb3Z8taqgS1zqZ5U1pVfQhLkCDSikM=

data/.yardopts

@@ -0,0 +1,2 @@
+--markup markdown
+--no-private

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+## master
+[full changelog](https://github.com/sue445/syobocalite/compare/v0.1.0...master)
+
+## 0.1.0
+* first release

data/Gemfile

@@ -0,0 +1,6 @@
+source "https://rubygems.org"
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in syobocalite.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2018 sue445
+
+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,58 @@
+# Syobocalite
+
+Lite client for [Syoboi calendar](http://cal.syoboi.jp/) API.
+
+[![Build Status](https://travis-ci.org/sue445/syobocalite.svg?branch=master)](https://travis-ci.org/sue445/syobocalite)
+[![Coverage Status](https://coveralls.io/repos/github/sue445/syobocalite/badge.svg?branch=master)](https://coveralls.io/github/sue445/syobocalite?branch=master)
+[![Maintainability](https://api.codeclimate.com/v1/badges/9f77793acf8d5c24886e/maintainability)](https://codeclimate.com/github/sue445/syobocalite/maintainability)
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'syobocalite'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install syobocalite
+
+## Usage
+
+```ruby
+require "syobocalite"
+require "time"
+
+start_at = Time.parse("2018-10-07 08:30:00")
+end_at   = Time.parse("2018-10-07 09:00:00")
+
+# or
+
+Time.zone = "Tokyo"
+start_at = Time.zone.parse("2018-10-07 08:30:00")
+end_at   = Time.zone.parse("2018-10-07 09:00:00")
+
+# Get programs that start between 8:30 and 9:00
+Syobocalite.search(start_at: start_at, end_at: end_at)
+```
+
+`Syobocalite.search` returns `Array` of [`Syobocalite::Program`](lib/syobocalite/program.rb)
+
+## 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.
+
+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/sue445/syobocalite.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "syobocalite"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/syobocalite/program.rb

@@ -0,0 +1,81 @@
+module Syobocalite
+  class Program
+    # @!attribute pid
+    #   @return [Integer]
+    attr_accessor :pid
+
+    # @!attribute tid
+    #   @return [Integer]
+    attr_accessor :tid
+
+    # @!attribute st_time
+    #   @return [TimeWithZone]
+    attr_accessor :st_time
+
+    # @!attribute ed_time
+    #   @return [TimeWithZone]
+    attr_accessor :ed_time
+
+    # @!attribute ch_name
+    #   @return [String]
+    attr_accessor :ch_name
+
+    # @!attribute ch_id
+    #   @return [Integer]
+    attr_accessor :ch_id
+
+    # @!attribute count
+    #   @return [Integer]
+    attr_accessor :count
+
+    # @!attribute st_offset
+    #   @return [Integer]
+    attr_accessor :st_offset
+
+    # @!attribute sub_title
+    #   @return [String]
+    attr_accessor :sub_title
+
+    # @!attribute title
+    #   @return [String]
+    attr_accessor :title
+
+    # @!attribute prog_comment
+    #   @return [String]
+    attr_accessor :prog_comment
+
+    # @param attrs [Hash]
+    def initialize(attrs = {})
+      @pid          = attrs["PID"]&.to_i
+      @tid          = attrs["TID"]&.to_i
+      @st_time      = to_time(attrs["StTime"])
+      @ed_time      = to_time(attrs["EdTime"])
+      @ch_name      = attrs["ChName"]
+      @ch_id        = attrs["ChID"]&.to_i
+      @count        = attrs["Count"]&.to_i
+      @st_offset    = attrs["StOffset"]&.to_i
+      @sub_title    = sanitize_text(attrs["SubTitle"])
+      @title        = sanitize_text(attrs["Title"])
+      @prog_comment = attrs["ProgComment"]&.gsub(/^!/, "")
+    end
+
+    alias_method :story_number,  :count
+    alias_method :story_number=, :count=
+
+    private
+
+    def to_time(str)
+      return nil unless str
+
+      Time.use_zone("Tokyo") do
+        Time.zone.parse(str)
+      end
+    end
+
+    def sanitize_text(str)
+      return nil unless str
+
+      CGI.unescapeHTML(str)
+    end
+  end
+end

data/lib/syobocalite/version.rb

@@ -0,0 +1,3 @@
+module Syobocalite
+  VERSION = "0.1.0"
+end

data/lib/syobocalite.rb

@@ -0,0 +1,47 @@
+require "syobocalite/version"
+require "syobocalite/program"
+require "active_support/all"
+require "multi_xml"
+require "open-uri"
+
+module Syobocalite
+  # Search programs between `start_at` and `end_at`
+  #
+  # @param start_at [Time]
+  # @param end_at [Time]
+  #
+  # @return [Array<Program>]
+  #
+  # @see https://sites.google.com/site/syobocal/spec/cal_chk-php
+  def self.search(start_at:, end_at:)
+    xml = fetch(start_at: start_at, end_at: end_at)
+    response = MultiXml.parse(xml)
+    prog_items = response["syobocal"]["ProgItems"]["ProgItem"]
+
+    programs = prog_items.map { |prog_item| Syobocalite::Program.new(prog_item) }
+
+    programs.select do |program|
+      (start_at...end_at).cover?(program.st_time)
+    end
+  end
+
+  def self.fetch(start_at:, end_at:)
+    params = {}
+
+    if start_at.hour >= 5
+      params[:days]  = (end_at.to_date - start_at.to_date).to_i + 1
+      params[:start] = start_at.strftime("%Y-%m-%d")
+    else
+      # NOTE: If start_at is 2018/4/7, returns 2018/4/7 05:00 - 28:59(2018/4/8 04:59)
+      params[:days]  = (end_at.to_date - start_at.to_date).to_i + 2
+      params[:start] = (start_at - 1.day).strftime("%Y-%m-%d")
+    end
+
+    headers = {
+      "User-Agent" => "Syobocalite v#{Syobocalite::VERSION}",
+    }
+
+    open("http://cal.syoboi.jp/cal_chk.php?#{params.to_param}", headers).read
+  end
+  private_class_method :fetch
+end

data/syobocalite.gemspec

@@ -0,0 +1,49 @@
+
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "syobocalite/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "syobocalite"
+  spec.version       = Syobocalite::VERSION
+  spec.authors       = ["sue445"]
+  spec.email         = ["sue445@sue445.net"]
+
+  spec.summary       = %q{Lite client for Syoboi calendar}
+  spec.description   = %q{Lite client for Syoboi calendar}
+  spec.homepage      = "https://github.com/sue445/syobocalite"
+  spec.license       = "MIT"
+
+  spec.required_ruby_version = ">= 2.3.0"
+
+  if spec.respond_to?(:metadata)
+    spec.metadata["homepage_uri"] = spec.homepage
+    spec.metadata["source_code_uri"] = spec.homepage
+    spec.metadata["changelog_uri"] = "#{spec.homepage}/blob/master/CHANGELOG.md"
+  else
+    raise "RubyGems 2.0 or newer is required to protect against " \
+      "public gem pushes."
+  end
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "activesupport"
+  spec.add_dependency "multi_xml"
+
+  spec.add_development_dependency "bundler", "~> 1.16"
+  spec.add_development_dependency "codeclimate-test-reporter", "~> 1.0.0"
+  spec.add_development_dependency "coveralls"
+  spec.add_development_dependency "pry-byebug"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency "rspec-its"
+  spec.add_development_dependency "webmock"
+  spec.add_development_dependency "yard"
+end

metadata

@@ -0,0 +1,217 @@
+--- !ruby/object:Gem::Specification
+name: syobocalite
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- sue445
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2018-10-09 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: multi_xml
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+- !ruby/object:Gem::Dependency
+  name: codeclimate-test-reporter
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.0.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.0.0
+- !ruby/object:Gem::Dependency
+  name: coveralls
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: pry-byebug
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: rspec-its
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: yard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Lite client for Syoboi calendar
+email:
+- sue445@sue445.net
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".coveralls.yml"
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- ".yardopts"
+- CHANGELOG.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/syobocalite.rb
+- lib/syobocalite/program.rb
+- lib/syobocalite/version.rb
+- syobocalite.gemspec
+homepage: https://github.com/sue445/syobocalite
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/sue445/syobocalite
+  source_code_uri: https://github.com/sue445/syobocalite
+  changelog_uri: https://github.com/sue445/syobocalite/blob/master/CHANGELOG.md
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.3.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.7.7
+signing_key: 
+specification_version: 4
+summary: Lite client for Syoboi calendar
+test_files: []