roku 0.0.1 → 0.0.2

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (7) hide show
  1. checksums.yaml +4 -4
  2. data/README.md +40 -3
  3. data/lib/roku.rb +0 -1
  4. data/lib/roku/config.rb +1 -1
  5. data/lib/roku/version.rb +1 -1
  6. data/roku.gemspec +3 -4
  7. metadata +18 -17
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA1:
3
- metadata.gz: f907f79c82881fb79baaf6ea402696daf5279ac3
4
- data.tar.gz: bb2c02192e9b199e9271494e03b6eddc09ed9c01
3
+ metadata.gz: 16f2eefbb9a5eba34dd6a01f2b3dba741daa27fe
4
+ data.tar.gz: f9ee1dbc5392ee67d721086c07d63ac52a85b38a
5
5
  SHA512:
6
- metadata.gz: 451903448a40d429c3ca9940975884d6242a18ec8eddd7210b6387c8bac7672b2e39aadbd46949baf07e5dc2260ef340ebdb34808c4dd661293e074453d97b72
7
- data.tar.gz: 0b6ca39b5a8b446b71914e0df6afee35858fd57383647972fdb5733efe2c37f8eded7fe5cff2e8b7679d4f6a78267f4d73d0bab4229503191f0b9a873dce515d
6
+ metadata.gz: 77259b05ac48366f4acdc10d2d741002a9bb6067cf5b193cf9b719831a90b8ea064561630dab81a65b2e30650b40a77aaf13d681b9e246270841845f3b5987b6
7
+ data.tar.gz: 7bf7aa620738469ca378f00ff9ea357b9a4cf8a41a769822449be9ee06672d1e229e133c8470572bfdffe91254fbea56f64e469eb16e6e0b8f848b014c46306a
data/README.md CHANGED
@@ -1,6 +1,6 @@
1
- # Roku
1
+ # Roku Toolkit
2
2
 
3
- TODO: Write a gem description
3
+ A simple set of Roku development tools to ease and simplify deployment. Tested on OSX and Linux, should work on Windows.
4
4
 
5
5
  ## Installation
6
6
 
@@ -16,9 +16,46 @@ Or install it yourself as:
16
16
 
17
17
  $ gem install roku
18
18
 
19
+ ## Configuration
20
+
21
+ In order to use the Roku Toolkit, you must first initialize a `roku.yml` file. You have two options for placement of the `roku.yml` file.
22
+
23
+ ### Home Directory / Global Configuration (recommended if you only have one project)
24
+
25
+ This method is recommended if you only have one Roku project because it will allow you to run the `roku` command from any directory, including sub directories and from paths outside of your project root.
26
+
27
+ File location:
28
+ - Unix/OSX: `~/roku.yml` or `/Users/<username>/roku.yml`
29
+ - Windows XP: `<root>\Documents and Settings\<username>`
30
+ - Windows Vista and Up: `<root>\Users\<username>\roku.yml`
31
+
32
+ Example File:
33
+ ```yml
34
+ ip : "192.168.1.6"
35
+ username : "rokudev"
36
+ password : "1234"
37
+ directory : "/Users/exampleuser/code/brightscript/example_project"
38
+ ```
39
+
40
+ **Note:** It is important to note the additional `directory` key that is required for Global Configuration so that the Roku Toolkit may know where your project lives.
41
+
42
+ ### Project Configuration (recommended for multiple projects)
43
+
44
+ This method is recommended for multiple Roku projects because it allows for per-directory based configuration files. The downside to this method is that you must ensure you run the `roku` command from the project root where your `roku.yml` file is located.
45
+
46
+ File Location:
47
+ - File location should be the root of your project. (ie: ~/code/brightscript/example_project/roku.yml)
48
+
49
+ Example File:
50
+ ```yml
51
+ ip : "192.168.1.6"
52
+ username : "rokudev"
53
+ password : "1234"
54
+ ```
55
+
19
56
  ## Usage
20
57
 
21
- TODO: Write usage instructions here
58
+ Depending on your configuration (see above), simply run `roku` from your command line to build and deploy your project to your Roku development box.
22
59
 
23
60
  ## Contributing
24
61
 
data/lib/roku.rb CHANGED
@@ -2,7 +2,6 @@ require "roku/version"
2
2
  require "roku/config"
3
3
  require 'mechanize'
4
4
  require 'fileutils'
5
- require 'pry'
6
5
 
7
6
  module Roku
8
7
  autoload :Zip, "roku/zip"
data/lib/roku/config.rb CHANGED
@@ -12,7 +12,7 @@ module Roku
12
12
  private
13
13
 
14
14
  def config
15
- (@config ||= fetch_config).tap do |config|
15
+ @config ||= fetch_config.tap do |config|
16
16
  @directory = config['directory'] if config['directory']
17
17
  end
18
18
  rescue Errno::ENOENT
data/lib/roku/version.rb CHANGED
@@ -1,3 +1,3 @@
1
1
  module Roku
2
- VERSION = "0.0.1"
2
+ VERSION = "0.0.2"
3
3
  end
data/roku.gemspec CHANGED
@@ -8,8 +8,8 @@ Gem::Specification.new do |spec|
8
8
  spec.version = Roku::VERSION
9
9
  spec.authors = ["Stephen Baldwin"]
10
10
  spec.email = ["stephenbaldwin@me.com"]
11
- spec.summary = %q{Roku Dev Tools}
12
- spec.description = %q{Roku Dev Tools in ruby}
11
+ spec.summary = %q{Roku Toolkit}
12
+ spec.description = %q{A set of tools built in Ruby to ease and simplify Roku development and deployment.}
13
13
  spec.homepage = ""
14
14
  spec.license = "MIT"
15
15
 
@@ -19,10 +19,9 @@ Gem::Specification.new do |spec|
19
19
  spec.require_paths = ["lib"]
20
20
 
21
21
  spec.add_dependency "rubyzip"
22
+ spec.add_dependency 'mechanize'
22
23
 
23
24
  spec.add_development_dependency "bundler", "~> 1.5"
24
25
  spec.add_development_dependency "rake"
25
26
  spec.add_development_dependency "pry"
26
-
27
- spec.add_dependency 'mechanize'
28
27
  end
metadata CHANGED
@@ -1,7 +1,7 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: roku
3
3
  version: !ruby/object:Gem::Version
4
- version: 0.0.1
4
+ version: 0.0.2
5
5
  platform: ruby
6
6
  authors:
7
7
  - Stephen Baldwin
@@ -25,35 +25,35 @@ dependencies:
25
25
  - !ruby/object:Gem::Version
26
26
  version: '0'
27
27
  - !ruby/object:Gem::Dependency
28
- name: bundler
28
+ name: mechanize
29
29
  requirement: !ruby/object:Gem::Requirement
30
30
  requirements:
31
- - - "~>"
31
+ - - ">="
32
32
  - !ruby/object:Gem::Version
33
- version: '1.5'
34
- type: :development
33
+ version: '0'
34
+ type: :runtime
35
35
  prerelease: false
36
36
  version_requirements: !ruby/object:Gem::Requirement
37
37
  requirements:
38
- - - "~>"
38
+ - - ">="
39
39
  - !ruby/object:Gem::Version
40
- version: '1.5'
40
+ version: '0'
41
41
  - !ruby/object:Gem::Dependency
42
- name: rake
42
+ name: bundler
43
43
  requirement: !ruby/object:Gem::Requirement
44
44
  requirements:
45
- - - ">="
45
+ - - "~>"
46
46
  - !ruby/object:Gem::Version
47
- version: '0'
47
+ version: '1.5'
48
48
  type: :development
49
49
  prerelease: false
50
50
  version_requirements: !ruby/object:Gem::Requirement
51
51
  requirements:
52
- - - ">="
52
+ - - "~>"
53
53
  - !ruby/object:Gem::Version
54
- version: '0'
54
+ version: '1.5'
55
55
  - !ruby/object:Gem::Dependency
56
- name: pry
56
+ name: rake
57
57
  requirement: !ruby/object:Gem::Requirement
58
58
  requirements:
59
59
  - - ">="
@@ -67,20 +67,21 @@ dependencies:
67
67
  - !ruby/object:Gem::Version
68
68
  version: '0'
69
69
  - !ruby/object:Gem::Dependency
70
- name: mechanize
70
+ name: pry
71
71
  requirement: !ruby/object:Gem::Requirement
72
72
  requirements:
73
73
  - - ">="
74
74
  - !ruby/object:Gem::Version
75
75
  version: '0'
76
- type: :runtime
76
+ type: :development
77
77
  prerelease: false
78
78
  version_requirements: !ruby/object:Gem::Requirement
79
79
  requirements:
80
80
  - - ">="
81
81
  - !ruby/object:Gem::Version
82
82
  version: '0'
83
- description: Roku Dev Tools in ruby
83
+ description: A set of tools built in Ruby to ease and simplify Roku development and
84
+ deployment.
84
85
  email:
85
86
  - stephenbaldwin@me.com
86
87
  executables:
@@ -123,5 +124,5 @@ rubyforge_project:
123
124
  rubygems_version: 2.2.2
124
125
  signing_key:
125
126
  specification_version: 4
126
- summary: Roku Dev Tools
127
+ summary: Roku Toolkit
127
128
  test_files: []