geewiz 0.1.1 → 0.1.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d1f5049589b6ab231bba0aab5d7d437da6240845b83d92e2af6e4ad2930d8105
-  data.tar.gz: dd0b70dcf9b924f46d595bd19bba021dabc5b407f6024f7f009b91d00a4cb2ea
+  metadata.gz: 470c2e0206995689b82812d1d2a357e9baf0f818ec89cc27153c597c6e6231cf
+  data.tar.gz: 392f167bcfa145c10c67a2c70789041b8dec625283b25f6606a6e3b305326479
 SHA512:
-  metadata.gz: 862ddeb1f9b44362af4761bd23796a23aa623ae681a8d44c4e494385ff45d9fd497dfea448d77127aea30716aea66749629281975f4bd7e4d4be7e6254e86d8a
-  data.tar.gz: ba0beadf1268fe38d63227a8286fc7a9d9d1dbe00cc41790ca2ca1a31f334169ff4bd86dab7a1c48c2b80dac73c24055d72f04e4f08f995a5b1f39079e18c304
+  metadata.gz: d52dc1c3183b15bfb9bd1564f3ac7f8b1abeada4d5b5de47fb54a8226a21f48bd171a73803a5a0adad5e8ce681fb61822f331b2035826c21af95081434cc7e0e
+  data.tar.gz: 210d522fdb5488dbabfb77cd8896fa09a98851518cdcc193e786550c7cc7a0432d4aea5cfb2c8465a878b3b48d590083a0bb48bc16b3bd012f6d25260eaa5a74

data/README.md

@@ -1,32 +1,136 @@
 # Geewiz
 
-Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/geewiz`. To experiment with that code, run `bin/console` for an interactive prompt.
-
-TODO: Delete this and the text above, and describe your gem
+SDK for interacting with Geewiz. Works with Ruby 2.6 (the version that currently come preinstalled on MacOS) and above.
 
 ## Installation
 
-Install the gem and add to the application's Gemfile by executing:
+### For use with MacOS's system Ruby 2.6.0 using `bundler`
+
+To start a new project using MacOS's preinstalled Ruby:
+
+Make a new directory for your project
+
+```bash
+mkdir my-new-project
+cd my-new-project
+```
+
+Configure Bundler to use the `vendor/bundle` directory for your gems instead of installing them system wide, which requires root access:
+
+```bash
+bundle config --local path vendor/bundle
+
+# Ignore the bundled gems in git
+echo /vendor/ >> .gitignore
+```
+
+Create a new Gemfile
 
-    $ bundle add geewiz
+```bash
+# Make a new Gemfile
+bundle init
 
-If bundler is not being used to manage dependencies, install the gem by executing:
+# Add the gem to the Gemfile
+bundle add geewiz
+```
+
+To use the gem in your project:
+
+```ruby
+require 'bundler/setup'
+require 'geewiz'
+
+Geewiz.card "hello-world-card"
+```
+
+### For most other cases:
+
+```bash
+bundle add geewiz
+```
+
+or
+
+```bash
+gem install geewiz
+```
 
-    $ gem install geewiz
 
 ## Usage
 
-TODO: Write usage instructions here
+### Requiring the gem
+
+```ruby
+require 'bundler/setup' # you may need to require this if you're using bundler
+
+require 'geewiz'
+```
+
+### Showing a card
+
+```ruby
+# show a card with the id "my_card_id"
+result = Geewiz.card :my_card_id
+result = Geewiz.card "another-card-id" # all data going to Geewiz is json encoded, so either symbols or strings are fine
+
+# show a card with the id "my_card_id" override `type` and `selectOne` parameters
+result = Geewiz.card :my_card_id, type: "selectOne", items: ["one", "two", "three"]
+
+# show a card with no id
+result = Geewiz.card type: "selectOne", items: ["one", "two", "three"]
+
+# `vars:` can be used to send variables to Geewiz before showing a card
+#    (it's a bit cleaner than using `Geewiz.vars[]=` directly)
+result = Geewiz.card :my_card, vars: { my_var: "my value", another_var: "another value" }
+
+# if card doesn't have an input, or you don't need the input:
+Geewiz.card :my_card_without_input
+```
+
+### Setting a variable
+
+```ruby
+Geewiz.vars[:my_var] = "my value"
+Geewiz.vars['my-var-with-dashes'] = "my value" # strings are fine as variable names
+
+# you can use the variables in Ruby
+Geewiz.vars[:username] = load_username_from_db
+
+if Geewiz.vars[:username] == 'nicholaides'
+  # ...
+end
+
+# this also works for setting one variable
+Geewiz.var :my_var, "my value"
+```
+
+### Setting the title of the app
+
+```ruby
+Geewiz.set title: "my app"
+```
+
+### Getting user config
+
+```ruby
+config_value = Geewiz.get_user_config :my_key
+```
 
-## Development
+### Using the global client (simplest way to use the gem)
 
-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.
+```ruby
+Geewiz.card :my_card_id
+```
 
-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 the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+### Using a non-global client (better for testing/mocking)
 
-## Contributing
+```ruby
+geewiz = Geewiz::Client.new
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/geewiz.
+geewiz.set title: "my app"
+geewiz.vars[:my_var] = "my value"
+result = geewiz.card :my_card_id
+```
 
 ## License
 

data/lib/geewiz/client.rb

@@ -10,27 +10,39 @@ module Geewiz
       @vars = VarCache.new(self)
     end
 
-    def command(type, **params) = @output.print "@#{[type, params].to_json}\n"
+    def command(type, **params)
+      @output.print "@#{[type, params].to_json}\n"
+    end
 
-    def read = @input.readline
+    def read
+      @input.readline
+    end
 
-    def read_response = JSON.parse(read)
+    def read_response
+      JSON.parse(read)
+    end
 
-    def set(**options) = command("set", **options)
+    def set(**options)
+      command("set", **options)
+    end
 
     def card(id = nil, vars: {}, **params)
+      if params[:responseFormat] && params[:responseFormat].to_s != "json"
+        raise Error, "responseFormat cannot be set to anything other than json"
+      end
+
       vars.each { |name, value| var(name, value) }
-      command "card", **params, **(id ? { id: } : {}), responseFormat: "json"
+      command "card", **params, **(id ? { id: id } : {}), responseFormat: "json"
       read_response
     end
 
     def get_user_config(key)
-      command "get-user-config", key:, responseFormat: "json"
+      command "get-user-config", key: key, responseFormat: "json"
       read_response
     end
 
     def var(name, value)
-      command("var", name:, value:)
+      command("var", name: name, value: value)
       vars.store name, value
     end
   end

data/lib/geewiz/var_cache.rb

@@ -6,7 +6,9 @@ module Geewiz
       @vars = {}
     end
 
-    def [](name) = @vars[name.to_s]
+    def [](name)
+      @vars[name.to_s]
+    end
 
     def []=(*args)
       @client.var(*args)

data/lib/geewiz/version.rb

@@ -1,3 +1,3 @@
 module Geewiz
-  VERSION = "0.1.1".freeze
+  VERSION = "0.1.3".freeze
 end

data/lib/geewiz.rb

@@ -11,17 +11,31 @@ module Geewiz
 
   module_function
 
-  def initialize_client(...)
-    @client = Client.new(...)
+  def initialize_client(*args, **options)
+    @client = Client.new(*args, **options)
   end
 
-  def client(...)
-    @client ||= initialize_client(...)
+  def client(*args, **options)
+    @client ||= initialize_client(*args, **options)
   end
 
-  def set(...)             = client.set(...)
-  def card(...)            = client.card(...)
-  def get_user_config(...) = client.get_user_config(...)
-  def var(...)             = client.var(...)
-  def vars(...)            = client.vars(...)
+  def set(*args, **options)
+    client.set(*args, **options)
+  end
+
+  def card(*args, **options)
+    client.card(*args, **options)
+  end
+
+  def get_user_config(*args, **options)
+    client.get_user_config(*args, **options)
+  end
+
+  def var(*args, **options)
+    client.var(*args, **options)
+  end
+
+  def vars
+    client.vars
+  end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: geewiz
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.3
 platform: ruby
 authors:
 - Mike Nicholaides
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-08-10 00:00:00.000000000 Z
+date: 2024-08-19 00:00:00.000000000 Z
 dependencies: []
 description: Geewiz SDK for Ruby
 email:
@@ -17,9 +17,7 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- LICENSE.txt
 - README.md
-- geewiz.gemspec
 - lib/geewiz.rb
 - lib/geewiz/client.rb
 - lib/geewiz/var_cache.rb
@@ -39,14 +37,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 3.1.0
+      version: 2.6.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.27
+rubygems_version: 3.5.11
 signing_key:
 specification_version: 4
 summary: Geewiz SDK for Ruby

data/LICENSE.txt

@@ -1,21 +0,0 @@
-The MIT License (MIT)
-
-Copyright (c) 2024 Mike Nicholaides
-
-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/geewiz.gemspec

@@ -1,38 +0,0 @@
-require_relative "lib/geewiz/version"
-
-Gem::Specification.new do |spec|
-  spec.name = "geewiz"
-  spec.version = Geewiz::VERSION
-  spec.authors = ["Mike Nicholaides"]
-  spec.email = ["mike@nicholaides.com"]
-
-  spec.summary = "Geewiz SDK for Ruby"
-  spec.description = "Geewiz SDK for Ruby"
-  # spec.homepage = "TODO: Put your gem's website or public repo URL here."
-  spec.license = "MIT"
-  spec.required_ruby_version = ">= 3.1.0"
-
-  spec.metadata["allowed_push_host"] = "https://rubygems.org"
-  spec.metadata["rubygems_mfa_required"] = "true"
-
-  # spec.metadata["homepage_uri"] = spec.homepage
-  # spec.metadata["source_code_uri"] = "TODO: Put your gem's public repo URL here."
-  # spec.metadata["changelog_uri"] = "TODO: Put your gem's CHANGELOG.md URL here."
-
-  # 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(__dir__) do
-    `git ls-files -z`.split("\x0").reject do |f|
-      (f == __FILE__) || f.match(%r{\A(?:(?:bin|test|spec|features)/|\.(?:git|travis|circleci)|appveyor)})
-    end
-  end - %w[.rspec .rubocop.yml .rubocop_todo.yml Gemfile Gemfile.lock Rakefile]
-  spec.bindir = "exe"
-  spec.executables = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
-  spec.require_paths = ["lib"]
-
-  # Uncomment to register a new dependency of your gem
-  # spec.add_dependency "example-gem", "~> 1.0"
-
-  # For more information and examples about making a new gem, check out our
-  # guide at: https://bundler.io/guides/creating_gem.html
-end