blockscore 4.1.2 → 4.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 82446b25c65c2a01e5e3c8c6a66b9b426500f2f0
-  data.tar.gz: c0776cba02503baebf61956f08b0ce1b8f841352
+  metadata.gz: 31656e876ca18bd6ba1359ba1492353965581e9f
+  data.tar.gz: 0a9bdf94792ba330ec53704244cfa0ad422c3f60
 SHA512:
-  metadata.gz: ab554cbb20db9964d566c42f2db836d8f42ef9b7cec15b2a9924f1208af561390b191d86f883afb2e1ea40cd0b7402c56f06b731acf48a71f65f35a6bca748e2
-  data.tar.gz: 4e52cee7599adbfc38e050e3427e28d90f3e45e90ece57a221db131c17286606835a7d7f7265bb04c9a21ca713814781bb649ea908de9658271dab95d305bc69
+  metadata.gz: a224c33dceda3aef587dc99c2aab9b88013e90bbd49cee3736642d057609030c9dcd61d0e28d1b7f9dc5caf29994100eeddb17888d7ac84d9850e0b727038da9
+  data.tar.gz: f520cb0f7700a006c914670b9146bfe7ed4c1b4dcff70576eaa78962c5c3498637675b4383e8736a400798374cf21d5da5b621a4b283c3bd46188e1c8af87843

data/.gitignore

@@ -1,3 +1,4 @@
+
 # rcov generated
 coverage
 coverage.data
@@ -15,7 +16,7 @@ doc
 # jeweler generated
 pkg
 
-# Have editor/IDE/OS specific files you need to ignore? Consider using a global gitignore: 
+# Have editor/IDE/OS specific files you need to ignore? Consider using a global gitignore:
 #
 # * Create a file at ~/.gitignore
 # * Include files you want ignored

data/Gemfile

@@ -7,40 +7,3 @@ group :test do
     gem 'devtools', github: 'mbj/devtools'
   end
 end
-
-group :guard do
-  # Notifications for guard specs
-  gem 'growl', '~> 1.0.3'
-
-  # Filewatcher and runner
-  gem 'guard', '~> 2.12.4'
-
-  # Autorun documentation critic
-  gem 'guard-inch', '~> 0.1'
-
-  # Autogen docs
-  gem 'guard-yard', '~> 2.1'
-
-  # My fork of guard-yardstick which makes the keywords more prominent
-  gem 'guard-yardstick', github: 'backus/guard-yardstick', branch: 'color'
-
-  # Autorun style critic
-  gem 'guard-rubocop', '~> 1.2'
-
-  gem 'rubocop-rspec', '~> 1.3', github: 'nevir/rubocop-rspec'
-
-  # Autorun codesmell critic
-  gem 'guard-reek', '= 0.0.3', github: 'backus/guard-reek'
-
-  # Autorun similar code critic
-  gem 'guard-flay', '= 0.0.3', github: 'backus/guard-flay'
-
-  # Autorun painful code critic
-  gem 'guard-flog', '= 0.0.4', github: 'backus/guard-flog'
-
-  # Autorun specs
-  gem 'guard-rspec', '~> 4.6'
-
-  # rebundle
-  gem 'guard-bundler', '~> 2.1'
-end

data/README.md

@@ -13,7 +13,7 @@ gem install blockscore
 If you are using Rails, add the following to your `Gemfile`:
 
 ```ruby
-gem 'blockscore', '~> 4.1.2'
+gem 'blockscore', '~> 4.2.0'
 ```
 
 ## Getting Started
@@ -60,5 +60,5 @@ To see the list of calls you can make, please visit our [full Ruby API reference
 The test suite uses a public BlockScore API key that was created specifically to ease the testing and contribution processes. **Please do not enter personal details for tests.** In order to run the test suite:
 
 ```shell
-$ rake test
+$ rspec spec
 ```

data/blockscore.gemspec

@@ -29,6 +29,7 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency 'bundler', '~> 1.0'
   spec.add_development_dependency 'simplecov', '~> 0'
   spec.add_development_dependency 'rspec', '~> 3'
+  spec.add_development_dependency 'rspec-its', '~> 1'
   spec.add_development_dependency 'webmock', '~> 1.21'
   spec.add_development_dependency 'faker', '~> 1.4'
   spec.add_development_dependency 'factory_girl', '~> 4.5'

data/circle.yml

@@ -1,13 +1,7 @@
 dependencies:
   override:
-    - "rvm-exec 1.9.3-p551 bundle install"
-    - "rvm-exec 2.0.0-p598 bundle install"
-    - "rvm-exec 2.1.5 bundle install"
-    - "rvm-exec 2.2.0 bundle install"
-
+    - ./circleci.sh build
 test:
   override:
-    - "rvm-exec 1.9.3-p551 bundle exec rspec"
-    - "rvm-exec 2.0.0-p598 bundle exec rspec"
-    - "rvm-exec 2.1.5 bundle exec rspec"
-    - "rvm-exec 2.2.0 bundle exec rspec"
+    - ./circleci.sh spec:
+        parallel: true

data/circleci.sh

@@ -0,0 +1,11 @@
+#!/bin/bash
+RUBY_VERSIONS=(1.9.3-p551 2.0.0-p598 2.1.5 2.2.3)
+CIRCLE_NODE_RUBY_VERSION="${RUBY_VERSIONS[$CIRCLE_NODE_INDEX]}"
+
+if [[ "$1" = "build" ]]
+then
+  rvm-exec $CIRCLE_NODE_RUBY_VERSION bundle install;
+elif [[ "$1" = "spec" ]]
+then
+  rvm-exec $CIRCLE_NODE_RUBY_VERSION rspec;
+fi

data/lib/blockscore.rb

@@ -1,3 +1,4 @@
+require 'delegate'
 require 'forwardable'
 require 'httparty'
 require 'json'
@@ -26,6 +27,7 @@ require 'blockscore/question_set'
 require 'blockscore/watchlist_hit'
 
 require 'blockscore/collection'
+require 'blockscore/collection/member'
 require 'blockscore/connection'
 require 'blockscore/dispatch'
 require 'blockscore/fingerprint'
@@ -34,11 +36,7 @@ require 'blockscore/util'
 require 'blockscore/version'
 
 module BlockScore
-  def self.api_key=(api_key)
-    @api_key = api_key
-  end
-
-  def self.api_key
-    @api_key
+  class << self
+    attr_accessor :api_key
   end
 end

data/lib/blockscore/actions/retrieve.rb

@@ -11,8 +11,10 @@ module BlockScore
     # => #<BlockScore::Person:0x007fe39c424410>
     module Retrieve
       module ClassMethods
-        def retrieve(id)
-          get("#{endpoint}/#{id}", {})
+        def retrieve(id, options = {})
+          fail ArgumentError if id.empty?
+          req = ->() { get("#{endpoint}/#{id}", options) }
+          new(id: id, &req)
         end
       end
 

data/lib/blockscore/actions/update.rb

@@ -28,7 +28,7 @@ module BlockScore
       def_delegators 'self.class', :endpoint, :patch
 
       def save!
-        if respond_to? :id
+        if persisted?
           patch("#{endpoint}/#{id}", filter_params)
           true
         else

data/lib/blockscore/base.rb

@@ -4,19 +4,37 @@ module BlockScore
   class Base
     extend Connection
 
-    attr_reader :attributes
-
-    def initialize(options = {})
+    def initialize(options = {}, &block)
+      @loaded = !(block)
+      @proc = block
       @attributes = options
     end
 
+    def attributes
+      return @attributes if @loaded
+      force!
+      @attributes
+    end
+
+    def force!
+      res = @proc.call
+      @attributes = res.attributes.merge(@attributes)
+      @loaded = true
+      self
+    end
+
+    def id
+      @attributes.fetch(:id, nil)
+    end
+
     def inspect
-      "#<#{self.class}:0x#{object_id.to_s(16)} JSON: " + JSON.pretty_generate(attributes)
+      str_attr = "JSON:#{JSON.pretty_generate(attributes)}"
+      "#<#{self.class}:0x#{object_id.to_s(16)} #{str_attr}>"
     end
 
     def refresh
-      r = self.class.retrieve(id)
-      @attributes = r.attributes
+      res = self.class.retrieve(id)
+      @attributes = res.attributes
 
       true
     rescue Error
@@ -45,16 +63,18 @@ module BlockScore
     end
 
     def self.endpoint
-      if self == Base
-        fail NotImplementedError, 'Base is an abstract class, not an API resource'
-      end
+      fail NotImplementedError, 'Base is an abstract class, not an API resource' if equal?(Base)
 
       "#{api_url}#{Util.to_plural(resource)}"
     end
 
+    def persisted?
+      !id.nil?
+    end
+
     protected
 
-    def add_accessor(symbol, *args)
+    def add_accessor(symbol, *_args)
       singleton_class.instance_eval do
         define_method(symbol) do
           wrap_attribute(attributes[symbol])

data/lib/blockscore/collection.rb

@@ -1,18 +1,239 @@
 module BlockScore
+  # Collection is a proxy between the parent and the asssociated members
+  # where parent is some instance of a resource
+  #
   class Collection < Array
-    def initialize(target)
-      super()
-      @target = target
+    # @!attribute [r] parent
+    # resource which owns a collection of other resources
+    #
+    # @example
+    #   person.question_sets.parent # => person
+    #
+    # @return [BlockScore::Base] a resource
+    #
+    # @api private
+    attr_reader :parent
+
+    # Sets parent and member_class then registers embedded ids
+    #
+    # @param [BlockScore::Base] parent
+    # @param [Class] class of collection members
+    #
+    # @return [undefined]
+    #
+    # @api private
+    def initialize(parent, member_class)
+      @parent       = parent
+      @member_class = member_class
+      register_parent_data
+    end
+
+    # Syntactic sugar method for returning collection
+    #
+    # @example
+    #   all # returns collection
+    #
+    # @return [self]
+    #
+    # @api public
+    def all
+      self
+    end
+
+    # Initializes new {member_class} with `params`
+    #
+    # - Ensures a parent id is meged into `params` (see #default_params).
+    # - Defines method `#save` on new collection member
+    # - Adds new item to collection
+    #
+    # @example usage
+    #
+    #   >> person = person = BlockScore::Person.retrieve('55de4af7643735000300000f')
+    #   >> person.question_sets.new
+    #   => #<BlockScore::QuestionSet:0x3fc67902f1b4 JSON:{
+    #     "person_id": "55de4af7643735000300000f"
+    #   }>
+    #
+    # @param params [Hash] initial params for member
+    #
+    # @return instance of {member_class}
+    #
+    # @api public
+    def new(params = {})
+      attributes = params.merge(default_params)
+      instance   = member_class.new(attributes)
+
+      new_member(instance) do |member|
+        self << member
+      end
+    end
+
+    # Relaod the contents of the collection
+    #
+    # @example usage
+    #   person.question_sets.refresh # => [#<BlockScore::QuestionSet...]
+    #
+    # @return [self]
+    #
+    # @api public
+    def refresh
+      clear
+      register_parent_data
+      self
     end
 
-    def respond_to?(method, include_all = false)
-      @target.respond_to?(method, include_all)
+    # Name of parent resource
+    #
+    # @example
+    #   self.parent_name # => 'person'
+    #
+    # @return [String]
+    #
+    # @api semipublic
+    def parent_name
+      parent.class.resource
+    end
+
+    # Initialize a collection member and save it
+    #
+    # @example
+    #   >> person.question_sets.create
+    #   => #<BlockScore::QuestionSet:0x3fc67a6007f4 JSON:{
+    #     "object": "question_set",
+    #     "id": "55ef5d5b62386200030001b3",
+    #     "created_at": 1441750363,
+    #     ...
+    #     }
+    #
+    # @param params [Hash] params
+    #
+    # @return new saved instance of {member_class}
+    #
+    # @api public
+    def create(params = {})
+      fail Error, 'Create parent first' unless parent.id
+      assoc_params = default_params.merge(params)
+      instance = member_class.create(assoc_params)
+
+      new_member(instance) do |member|
+        register_to_parent(member)
+      end
+    end
+
+    # Retrieve a collection member by its id
+    #
+    # @example usage
+    #   person.question_sets.retrieve('55ef5b4e3532630003000178') # => instance of QuestionSet
+    #
+    # @param id [String] resource id
+    #
+    # @return instance of {member_class} if found
+    # @raise [BlockScore::NotFoundError] otherwise
+    #
+    # @api public
+    def retrieve(id)
+      each do |item|
+        next unless item.id == id
+        return item
+      end
+
+      instance = member_class.retrieve(id)
+
+      new_member(instance) do |member|
+        register_to_parent(member)
+      end
+    end
+
+    protected
+
+    # @!attribute [r] member_class
+    # class which will be used for the embedded
+    # resources in the collection
+    #
+    # @return [Class]
+    #
+    # @api private
+    attr_reader :member_class
+
+    # Default params for making an instance of {member_class}
+    #
+    # @return [Hash]
+    #
+    # @api private
+    def default_params
+      {
+        foriegn_key => parent.id
+      }
     end
 
     private
 
-    def method_missing(method, *args, &block)
-      @target.public_send(method, *args, &block)
+    # Generate foriegn key name for parent resource
+    #
+    # @return [Symbol] resource name as id
+    #
+    # @api private
+    def foriegn_key
+      :"#{parent_name}_id"
+    end
+
+    # Initialize a new collection member
+    #
+    # @param instance [BlockScore::Base] collection member instance
+    # @yield [Member] initialized member
+    #
+    # @return [Member] new member
+    #
+    # @api private
+    def new_member(instance, &blk)
+      Member.new(parent, instance).tap(&blk)
+    end
+
+    # Check if `parent_id` is defined on `item`
+    #
+    # @param item [BlockScore::Base] any resource
+    #
+    # @return [Boolean]
+    #
+    # @api private
+    def parent_id?(item)
+      parent.id && item.send(foriegn_key) == parent.id
+    end
+
+    # Register a resource in collection
+    #
+    # @param item [BlockScore::Base] a resource
+    #
+    # @raise [BlockScore::Error] if no `parent_id`
+    # @return [BlockScore::Base] otherwise
+    #
+    # @api private
+    def register_to_parent(item)
+      fail Error, 'None belonging' unless parent_id?(item)
+      ids << item.id
+      self << item
+      item
+    end
+
+    # Fetches embedded ids from parent and adds to self
+    #
+    # @return [undefined]
+    #
+    # @api private
+    def register_parent_data
+      ids.each do |id|
+        item = member_class.retrieve(id)
+        self << item
+      end
+    end
+
+    # ids that belong to the collection
+    #
+    # @return [Array<String>]
+    #
+    # @api private
+    def ids
+      parent.attributes.fetch(:"#{Util.to_plural(member_class.resource)}", [])
     end
   end
 end

data/lib/blockscore/collection/member.rb

@@ -0,0 +1,100 @@
+module BlockScore
+  class Collection
+    # Member of a {Collection} class
+    class Member < SimpleDelegator
+      # Initialize a new member
+      #
+      # @param parent [BlockScore::Base] parent resource
+      # @param instance [BlockScore::Base] member instance
+      #
+      # @return [undefined]
+      #
+      # @api private
+      def initialize(parent, instance)
+        @instance = instance
+        @parent = parent
+
+        super(instance)
+      end
+
+      # Save parent, set parent id, and save instance
+      #
+      # @example
+      #   # saves both unsaved person and unsaved question_set
+      #   person = Person.new(attributes)
+      #   question_set = QuestionSet.new
+      #   Member.new(person, question_set).save
+      #
+      # @return return value of instance `#save`
+      #
+      # @api public
+      def save
+        save_parent
+        send(:"#{parent_name}_id=", parent.id)
+        result = instance.save
+        ids.push(instance.id) unless ids.include?(instance.id)
+        result
+      end
+
+      private
+
+      # Name of parent resource
+      #
+      # @example
+      #   self.parent_name # => 'person'
+      #
+      # @return [String]
+      #
+      # @api private
+      def parent_name
+        parent.class.resource
+      end
+
+      # Save parent if it hasn't already been saved
+      #
+      # @return return of parent.save if previously unsaved
+      # @return nil otherwise
+      #
+      # @api private
+      def save_parent
+        parent.save unless parent_saved?
+      end
+
+      # Check if parent is saved
+      #
+      # @return [Boolean]
+      #
+      # @api private
+      def parent_saved?
+        parent.id
+      end
+
+      # @!attribute [r] instance
+      # member instance methods are delegated to
+      #
+      # @return [BlockScore::Base]
+      #
+      # @api private
+      attr_reader :instance
+
+      # @!attribute [r] parent
+      # collection parent the collectino conditionally updates
+      #
+      # @return [BlockScore::Base]
+      #
+      # @api private
+      attr_reader :parent
+
+      private
+
+      # ids that belong to associated parent resource
+      #
+      # @return [Array<String>]
+      #
+      # @api private
+      def ids
+        parent.attributes.fetch(:"#{Util.to_plural(instance.class.resource)}", [])
+      end
+    end
+  end
+end

data/lib/blockscore/connection.rb

@@ -32,7 +32,7 @@ module BlockScore
       begin
         response = execute_request(method, path, params)
       rescue SocketError, Errno::ECONNREFUSED => e
-        fail APIConnectionError, e.message
+        raise APIConnectionError, e.message
       end
 
       Response.handle_response(resource, response)
@@ -55,7 +55,7 @@ module BlockScore
 
     def encode_path_params(path, params)
       encoded = URI.encode_www_form(params)
-      [path, encoded].join("?")
+      [path, encoded].join('?')
     end
   end
 end

data/lib/blockscore/errors/api_error.rb

@@ -15,7 +15,7 @@ module BlockScore
     # APIError - Indicates an error on the server side (HTTP 5xx)
     # AuthenticationError - Indicates an authentication error (HTTP 401)
     def initialize(response)
-      body = JSON.parse(response.body, :symbolize_names => true)
+      body = JSON.parse(response.body, symbolize_names: true)
 
       @message = body[:error][:message]
       @http_status = response.code
@@ -24,8 +24,8 @@ module BlockScore
     end
 
     def to_s
-      status_string = @http_status ? "(Status: #{@http_status})" : ""
-      type_string = @error_type ? "(Type: #{@error_type})" : ""
+      status_string = @http_status ? "(Status: #{@http_status})" : ''
+      type_string = @error_type ? "(Type: #{@error_type})" : ''
 
       "#{type_string} #{@message} #{status_string}"
     end

data/lib/blockscore/errors/invalid_request_error.rb

@@ -19,9 +19,9 @@ module BlockScore
     end
 
     def to_s
-      status_string = @http_status ? "(Status: #{@http_status})" : ""
-      type_string = @error_type ? "(Type: #{@error_type})" : ""
-      param_string = @param ? "(#{@param})" : ""
+      status_string = @http_status ? "(Status: #{@http_status})" : ''
+      type_string = @error_type ? "(Type: #{@error_type})" : ''
+      param_string = @param ? "(#{@param})" : ''
 
       "#{type_string} #{@message} #{param_string} #{status_string}"
     end

data/lib/blockscore/person.rb

@@ -11,7 +11,7 @@ module BlockScore
 
     def initialize(options = {})
       super
-      @question_sets = Collection.new(QuestionSet.new(person: self))
+      @question_sets = Collection.new(self, QuestionSet)
     end
 
     def valid?

data/lib/blockscore/question_set.rb

@@ -6,14 +6,7 @@ module BlockScore
     include BlockScore::Actions::Retrieve
     include BlockScore::Actions::All
 
-    def_delegators 'self.class', :retrieve, :all, :post, :endpoint
-
-    def create
-      result = self.class.create(person_id: person.id)
-      person.question_sets << result.id
-
-      result
-    end
+    def_delegators 'self.class', :post, :endpoint
 
     def score(answers = nil)
       if answers.nil? && attributes

data/lib/blockscore/util.rb

@@ -11,13 +11,13 @@ module BlockScore
     }
 
     def parse_json!(json_obj)
-      JSON.parse(json_obj, :symbolize_names => true)
+      JSON.parse(json_obj, symbolize_names: true)
     end
 
     def parse_json(json_obj)
       parse_json! json_obj
     rescue JSON::ParserError
-      fail Error, "An error has occurred. If this problem persists, please message support@blockscore.com."
+      raise Error, 'An error has occurred. If this problem persists, please message support@blockscore.com.'
     end
 
     def create_object(resource, options = {})
@@ -65,16 +65,16 @@ module BlockScore
     end
 
     def to_camelcase(str)
-      str.split('_').map { |i| i.capitalize }.join('')
+      str.split('_').map(&:capitalize).join('')
     end
 
     # Taken from Rulers: http://git.io/vkWqf
     def to_underscore(str)
-      str.gsub(/::/, '/').
-      gsub(/([A-Z]+)([A-Z][a-z])/,'\1_\2').
-      gsub(/([a-z\d])([A-Z])/,'\1_\2').
-      tr("-", "_").
-      downcase
+      str.gsub(/::/, '/')
+        .gsub(/([A-Z]+)([A-Z][a-z])/, '\1_\2')
+        .gsub(/([a-z\d])([A-Z])/, '\1_\2')
+        .tr('-', '_')
+        .downcase
     end
   end
 end

data/lib/blockscore/version.rb

@@ -1,3 +1,3 @@
 module BlockScore
-  VERSION = '4.1.2'.freeze
-end
+  VERSION = '4.2.0'.freeze
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: blockscore
 version: !ruby/object:Gem::Version
-  version: 4.1.2
+  version: 4.2.0
 platform: ruby
 authors:
 - Alain Meier
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2015-08-28 00:00:00.000000000 Z
+date: 2015-09-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: httparty
@@ -96,6 +96,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3'
+- !ruby/object:Gem::Dependency
+  name: rspec-its
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1'
 - !ruby/object:Gem::Dependency
   name: webmock
   requirement: !ruby/object:Gem::Requirement
@@ -157,6 +171,7 @@ files:
 - Rakefile
 - blockscore.gemspec
 - circle.yml
+- circleci.sh
 - lib/blockscore.rb
 - lib/blockscore/actions/all.rb
 - lib/blockscore/actions/create.rb
@@ -166,6 +181,7 @@ files:
 - lib/blockscore/base.rb
 - lib/blockscore/candidate.rb
 - lib/blockscore/collection.rb
+- lib/blockscore/collection/member.rb
 - lib/blockscore/company.rb
 - lib/blockscore/connection.rb
 - lib/blockscore/dispatch.rb