ruby_afplay 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: b616a938ee774b6eed7b80787e96daff853866ed5aed36f1ae442003c269d545
+  data.tar.gz: 56d62e82a7ffc8d73d612793e5720468d7e7a7c9c5949fdfe8d33594e1b1f842
+SHA512:
+  metadata.gz: 432773423f9448e114887826773d324ec2cd896edfa4aed92bca142c1d643079847a6ff686e1ad919ac9fbb77d18b1f85c87612c5c9cf80bfde9932e89afe2d8
+  data.tar.gz: 7be45e86f73ba1c2e83b58ec3c48079653ef13311ebb600c5775148ec4f3a6d19aca23426c6146110f18b75b44ca8bbc83d31aed31e5259580308f723e988956

data/.gitignore

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

data/.rspec

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

data/.travis.yml

@@ -0,0 +1,7 @@
+---
+sudo: false
+language: ruby
+cache: bundler
+rvm:
+  - 2.6.3
+before_install: gem install bundler -v 1.17.2

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at ianholla@gmail.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

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 ruby_afplay.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,38 @@
+PATH
+  remote: .
+  specs:
+    ruby_afplay (0.1.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    coderay (1.1.3)
+    diff-lcs (1.4.4)
+    method_source (1.0.0)
+    pry (0.13.1)
+      coderay (~> 1.1)
+      method_source (~> 1.0)
+    rspec (3.9.0)
+      rspec-core (~> 3.9.0)
+      rspec-expectations (~> 3.9.0)
+      rspec-mocks (~> 3.9.0)
+    rspec-core (3.9.2)
+      rspec-support (~> 3.9.3)
+    rspec-expectations (3.9.2)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.9.0)
+    rspec-mocks (3.9.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.9.0)
+    rspec-support (3.9.3)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  pry
+  rspec (~> 3.9)
+  ruby_afplay!
+
+BUNDLED WITH
+   2.1.4

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2020 ihollander
+
+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,70 @@
+# Ruby Afplay
+
+A gem to play audio from the command line using `afplay`. OS X only!
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'ruby_afplay'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install ruby_afplay
+
+## Usage
+
+Create a new player instance by passing in a path to an mp3 file:
+
+```rb
+player = RubyAfplay::Player.new("demo/test.mp3")
+```
+
+The `player` instance has three methods for interacting with the mp3 player:
+
+```rb
+player.play  # start/resume playing (and start afplay process)
+player.pause # pause playing
+player.stop  # stop playing (and kill afplay process)
+```
+
+Here's a simple example of playing/pausing/stopping file from the command line:
+
+```rb
+player = RubyAfplay::Player.new("demo/test.mp3", volume: 2, time: 10, rate: 0.5)
+
+input = nil
+while input != "exit"
+  puts `clear`
+  puts <<~MENU
+  Enter a command to control the audio player. Options: 
+
+  play  |  start playing audio or resume paused audio
+  pause |  pause playing audio
+  stop  |  stop playing
+  exit  |  exit player
+
+  MENU
+  print "Your Command: "
+  input = gets.chomp
+
+  case input
+  when "play"
+    player.play
+  when "pause"
+    player.pause
+  when "stop"
+    player.stop
+  when "exit"
+    player.stop
+  end
+end
+
+puts "TTFN!"
+```

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 "ruby_afplay"
+
+# 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/demo/player.rb

@@ -0,0 +1,32 @@
+require_relative "../lib/ruby_afplay"
+
+player = RubyAfplay::Player.new("demo/test.mp3", volume: 2, time: 10, rate: 0.5)
+
+input = nil
+while input != "exit"
+  puts `clear`
+  puts <<~MENU
+  Enter a command to control the audio player. Options: 
+
+  play  |  start playing audio or resume paused audio
+  pause |  pause playing audio
+  stop  |  stop playing
+  exit  |  exit player
+
+  MENU
+  print "Your Command: "
+  input = gets.chomp
+
+  case input
+  when "play"
+    player.play
+  when "pause"
+    player.pause
+  when "stop"
+    player.stop
+  when "exit"
+    player.stop
+  end
+end
+
+puts "TTFN!"

data/lib/ruby_afplay.rb

@@ -0,0 +1,8 @@
+require_relative "ruby_afplay/version"
+
+module RubyAfplay
+  class PlayerError < StandardError; end
+  # Your code goes here...
+end
+
+require_relative "ruby_afplay/player"

data/lib/ruby_afplay/player.rb

@@ -0,0 +1,55 @@
+module RubyAfplay
+  class Player
+
+    def initialize(file_path, options = {})
+      @command = file_path + build_options_string(options)
+    end
+    
+    def play
+      if @process_id
+        # resume playing if the process is already running
+        Process.kill("SIGCONT", @process_id)
+      else
+        start_process!
+      end
+    end
+  
+    def pause
+      # send a stop signal to afplay using the process_id
+      Process.kill("SIGSTOP", @process_id)
+    end
+  
+    def stop
+      # send a kill signal to aflpay using the process_id
+      Process.kill("SIGKILL", @process_id)
+      # detach the process
+      detach_process!
+    end
+  
+    private
+  
+    def build_options_string(options)
+      valid_options = %i(volume time rate quality)
+      options_string = ""
+      options.each do |key, value|
+        options_string += " -#{key[0]} #{value}" if valid_options.include?(key)
+      end
+      options_string
+    end
+
+    def start_process!
+      # start playing by running 'afplay'
+      # spawn lets us returns a process_id we can use with other commands
+      @process_id = spawn "afplay #{@command}"
+    end
+
+  
+    def detach_process!
+      # detaches process
+      Process.detach(@process_id)
+      # clear the process_id reference
+      @process_id = nil?
+    end
+
+  end
+end

data/lib/ruby_afplay/version.rb

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

data/ruby_afplay.gemspec

@@ -0,0 +1,37 @@
+
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "ruby_afplay/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "ruby_afplay"
+  spec.version       = RubyAfplay::VERSION
+  spec.authors       = ["ihollander"]
+  spec.email         = ["ianholla@gmail.com"]
+
+  spec.summary       = %q{A Ruby wrapper for Mac's `afplay`}
+  spec.homepage      = "https://github.com/ihollander/ruby_afplay"
+  spec.license       = "MIT"
+
+  # Prevent pushing this gem to RubyGems.org. To allow pushes either set the 'allowed_push_host'
+  # to allow pushing to a single host or delete this section to allow pushing to any host.
+  if spec.respond_to?(:metadata)
+    spec.metadata["homepage_uri"] = spec.homepage
+    spec.metadata["source_code_uri"] = "https://github.com/ihollander/ruby_afplay"
+  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_development_dependency "rspec", "~> 3.9"
+  spec.add_development_dependency "pry"
+end

metadata

@@ -0,0 +1,90 @@
+--- !ruby/object:Gem::Specification
+name: ruby_afplay
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- ihollander
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2020-08-20 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.9'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.9'
+- !ruby/object:Gem::Dependency
+  name: pry
+  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:
+email:
+- ianholla@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- demo/player.rb
+- demo/test.mp3
+- lib/ruby_afplay.rb
+- lib/ruby_afplay/player.rb
+- lib/ruby_afplay/version.rb
+- ruby_afplay.gemspec
+homepage: https://github.com/ihollander/ruby_afplay
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/ihollander/ruby_afplay
+  source_code_uri: https://github.com/ihollander/ruby_afplay
+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.8
+signing_key:
+specification_version: 4
+summary: A Ruby wrapper for Mac's `afplay`
+test_files: []