helio-ruby 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: ef9ddd9886c6fc86629b565221bc825ac87134c0
-  data.tar.gz: b61f9aa69bc11e35e604da85f85c8a145ec9066b
+SHA256:
+  metadata.gz: feb36836fb769782a32af06f1192ad06e67e8336fb3443005be71ffe1e86b9d4
+  data.tar.gz: f4121231cf11d6f55368cd94337957b6a7a476d060529241785ee25d22c545a8
 SHA512:
-  metadata.gz: 7d5ecd3e293ab9b0e848fb4aef69445c41ea5cb65a7fc72727665a805e5ccbb26f666750b7cba7ee436e1c555ab3516d46ce60b99e9d35c55abbfa7e574a84e6
-  data.tar.gz: 63f210a03dfab8ba406dceb2dfb6df94079a3840766f559aaa897123748a1f027314f2469ddfda7bc6e940fb03f820c2a96df311841c3facc109e2ac6290b721
+  metadata.gz: a200278d2f216a134db5db42f141159311812864983926e313f41dad191828df47d28d965f04866101dc30b832ee74bb05a38117827001a1a670c10298412b48
+  data.tar.gz: 414f534fe747254ff6b845591af4c64abb1a8a7fd06a4c32af5ecbebe3c58d2d8371434ca66bd7365c01ba5fd122bfdf646993534a3c56bbc49d2d828f985555

data/Gemfile

@@ -4,7 +4,7 @@ gemspec
 
 group :development do
   gem "coveralls", require: false
-  gem "mocha", "~> 0.13.2"
+  gem "mocha", "~> 1.7.0"
   gem "rake"
   gem "shoulda-context"
   gem "test-unit"

data/README.md

@@ -1,15 +1,18 @@
 # Helio Ruby Library
 
+### THIS GEM IS NOT PRODUCTION READY
+The first production release will be version 1.0.0. Until then, consider this gem unstable as the Helio API is in flux.
+
 ## Installation
 
 You don't need this source code unless you want to modify the gem. If you just
 want to use the package, just run:
 
-    gem install helio
+    gem install helio-ruby
 
 If you want to build the gem from source:
 
-    gem build helio.gemspec
+    gem build helio-ruby.gemspec
 
 ### Requirements
 
@@ -25,7 +28,7 @@ compromised in transit and alter the code of gems fetched securely over https:
 source 'https://rubygems.org'
 
 gem 'rails'
-gem 'helio'
+gem 'helio-ruby'
 ```
 
 ## Usage
@@ -36,12 +39,13 @@ value:
 
 ``` ruby
 require "helio"
+Helio.api_id = "..."
 Helio.api_token = "..."
 
-# list charges
+# list participants
 Helio::Participant.list()
 
-# retrieve single charge
+# retrieve single participant
 Helio::Participant.retrieve(
   "id",
 )
@@ -56,14 +60,14 @@ require "helio"
 
 Helio::Participant.list(
   {},
-  :api_token => "sk_test_...",
-  :api_id => "acct_..."
+  :api_token => "...",
+  :api_id => "..."
 )
 
 Helio::Participant.retrieve(
   "id",
-  :api_token => "token...",
-  :api_id => "acct_..."
+  :api_token => "...",
+  :api_id => "..."
 )
 ```
 
@@ -76,8 +80,8 @@ library use any client supported by [Faraday][faraday] by initializing a
 ``` ruby
 conn = Faraday.new
 client = Helio::HelioClient.new(conn)
-charge, resp = client.request do
-  Helio::participant.retrieve(
+participant, resp = client.request do
+  Helio::Participant.retrieve(
     "id",
   )
 end

data/VERSION

@@ -1 +1 @@
-0.1.0
+0.2.0

data/helio-ruby.gemspec

@@ -7,9 +7,9 @@ Gem::Specification.new do |s|
   s.version = Helio::VERSION
   s.required_ruby_version = '>= 2.0.0'
   s.summary = 'Ruby bindings for the Helio API'
-  s.description = 'Discover design insights with surveys and tests. See https://zurb.com/helio for details.'
+  s.description = 'Discover design insights with surveys and tests. See https://helio.app for details.'
   s.author = 'Helio'
-  s.email = 'helio@zurb.com'
+  s.email = 'help@helio.app'
   s.homepage = 'https://github.com/zurb/helio-ruby'
   s.license = 'MIT'
 

data/lib/helio-ruby.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 # Helio Ruby bindings
 # API spec at https://helio.zurb.com
 require "cgi"

data/lib/helio/api_operations/create.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Helio
   module APIOperations
     module Create

data/lib/helio/api_operations/delete.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Helio
   module APIOperations
     module Delete

data/lib/helio/api_operations/list.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Helio
   module APIOperations
     module List
@@ -17,12 +19,6 @@ module Helio
 
         obj
       end
-
-      # The original version of #list was given the somewhat unfortunate name of
-      # #all, and this alias allows us to maintain backward compatibility (the
-      # choice was somewhat misleading in the way that it only returned a single
-      # page rather than all objects).
-      alias all list
     end
   end
 end

data/lib/helio/api_operations/nested_resource.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Helio
   module APIOperations
     # Adds methods to help manipulate a subresource from its parent resource so

data/lib/helio/api_operations/request.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Helio
   module APIOperations
     module Request
@@ -44,7 +46,7 @@ module Helio
         base.extend(ClassMethods)
       end
 
-      protected
+    protected
 
       def request(method, url, params = {}, opts = {})
         opts = @opts.merge(Util.normalize_opts(opts))

data/lib/helio/api_operations/save.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Helio
   module APIOperations
     module Save
@@ -53,11 +55,17 @@ module Helio
 
         values = serialize_params(self).merge(params)
 
+        request_method = if self['id']
+          :put
+        else
+          :post
+        end
+
         # note that id gets removed here our call to #url above has already
         # generated a uri for this object with an identifier baked in
         values.delete(:id)
 
-        resp, opts = request(:post, save_url, values, opts)
+        resp, opts = request(request_method, save_url, values, opts)
         initialize_from(resp.data, opts)
       end
 
@@ -65,7 +73,7 @@ module Helio
         base.extend(ClassMethods)
       end
 
-      private
+    private
 
       def save_url
         # This switch essentially allows us "upsert"-like functionality. If the

data/lib/helio/api_resource.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Helio
   class APIResource < HelioObject
     include Helio::APIOperations::Request
@@ -49,7 +51,7 @@ module Helio
       unless (id = self["id"])
         raise InvalidRequestError.new("Could not determine which URL to request: #{self.class} instance has invalid ID: #{id.inspect}", "id")
       end
-      "#{self.class.resource_url}/#{CGI.escape(id)}"
+      "#{self.class.resource_url}/#{CGI.escape(id.to_s)}"
     end
 
     def refresh

data/lib/helio/customer_list.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Helio
   class CustomerList < APIResource
     extend Helio::APIOperations::Create
@@ -6,20 +8,20 @@ module Helio
     extend Helio::APIOperations::List
     extend Helio::APIOperations::NestedResource
 
-    OBJECT_NAME = "customer_list".freeze
+    OBJECT_NAME = "customer_list"
 
     save_nested_resource :participant
     nested_resource_class_methods :participant,
                                   operations: %i[create retrieve update delete list]
 
-    # class << self
-    #   alias detach_source delete_source
-    # end
-
     def add_participant(params, opts = {})
       opts = @opts.merge(Util.normalize_opts(opts))
-      Participant.create(params.merge(participant: id), opts)
+      Participant.create(params.merge(customer_list_id: id), opts)
     end
 
+    def participants(params = {}, opts = {})
+      resp, opts = request(:get, resource_url + "/participants", params, Util.normalize_opts(opts))
+      Util.convert_to_helio_object(resp.data, opts)
+    end
   end
 end

data/lib/helio/errors.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Helio
   # HelioError is the base error from which all other more specific Helio
   # errors derive.

data/lib/helio/helio_client.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Helio
   # HelioClient executes requests against the Helio API and allows a user to
   # recover both a resource a call returns as well as a response object that

data/lib/helio/helio_object.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Helio
   class HelioObject
     include Enumerable
@@ -209,7 +211,7 @@ module Helio
       []
     end
 
-    protected
+  protected
 
     def metaclass
       class << self; self; end

data/lib/helio/helio_response.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Helio
   # HelioResponse encapsulates some vitals of a response that came back from
   # the Helio API.

data/lib/helio/list_object.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Helio
   class ListObject < HelioObject
     include Enumerable
@@ -5,7 +7,7 @@ module Helio
     include Helio::APIOperations::Request
     include Helio::APIOperations::Create
 
-    OBJECT_NAME = "list".freeze
+    OBJECT_NAME = "list"
 
     # This accessor allows a `ListObject` to inherit various filters that were
     # given to a predecessor. This allows for things like consistent limits,

data/lib/helio/participant.rb

@@ -1,9 +1,12 @@
+# frozen_string_literal: true
+
 module Helio
   class Participant < APIResource
-    include Helio::APIOperations::Save
+    extend Helio::APIOperations::Create
     include Helio::APIOperations::Delete
+    include Helio::APIOperations::Save
     extend Helio::APIOperations::List
 
-    OBJECT_NAME = "participant".freeze
+    OBJECT_NAME = "participant"
   end
 end

data/lib/helio/singleton_api_resource.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Helio
   class SingletonAPIResource < APIResource
     def self.resource_url

data/lib/helio/util.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require "cgi"
 
 module Helio
@@ -8,19 +10,19 @@ module Helio
       :api_token,
       :idempotency_key,
       :helio_version
-    ].freeze
+    ]
 
     # Options that should be copyable from one HelioObject to another
     # including options that may be internal.
     OPTS_COPYABLE = (
       OPTS_USER_SPECIFIED + Set[:api_base]
-    ).freeze
+    )
 
     # Options that should be persisted between API requests. This includes
     # client, which is an object containing an HTTP client to reuse.
     OPTS_PERSISTABLE = (
       OPTS_USER_SPECIFIED + Set[:client] - Set[:idempotency_key]
-    ).freeze
+    )
 
     def self.objects_to_ids(h)
       case h
@@ -66,7 +68,7 @@ module Helio
         data.map { |i| convert_to_helio_object(i, opts) }
       when Hash
         # Try converting to a known object class.  If none available, fall back to generic HelioObject
-        object_classes.fetch(data[:object], HelioObject).construct_from(data, opts)
+        object_classes.fetch(data[:object_type], HelioObject).construct_from(data, opts)
       else
         data
       end

data/lib/helio/version.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Helio
-  VERSION = "0.1.0".freeze
+  VERSION = "0.2.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: helio-ruby
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Helio
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-12-15 00:00:00.000000000 Z
+date: 2018-12-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -24,9 +24,9 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '0.10'
-description: Discover design insights with surveys and tests. See https://zurb.com/helio
+description: Discover design insights with surveys and tests. See https://helio.app
   for details.
-email: helio@zurb.com
+email: help@helio.app
 executables:
 - helio-console
 extensions: []
@@ -84,7 +84,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.11
+rubygems_version: 2.7.6
 signing_key: 
 specification_version: 4
 summary: Ruby bindings for the Helio API