prosperworks-ruby 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 83799d280ed1a8852e37f6c479908691b2824d19
-  data.tar.gz: 39ae89fd82e3324e4708f9ff45083d4dfac841bf
+  metadata.gz: 178f861fcbab618ab5d7868804aaff682fec7afe
+  data.tar.gz: e50f45003f905d514bb09bc58e4ce8a44773fe74
 SHA512:
-  metadata.gz: 3005d1c1304ef277b933d4f5ea1017cce880d4192d4d2f0a3f3fb7dcca6a543e40d1cdad044d5744c6df3c11fede9034cc013fb46e5cc64a8a77f9617bb6312c
-  data.tar.gz: 111089593cbb962f1d2a4b33bcf07c15d8fb3f162423e61aae125a06267c8a12978192ae7fd8e1a02c02607dfbc8cbeb228b6270c526823df6a1c0f1f44f3d2c
+  metadata.gz: d711c8ca0e924dc2359ebe4401c44395ad39338bf223a5440d6059a0408bdcb9370a952a7c6e5c49a351c9355e7382c40ce1eb787b88ed26555223e9252b995e
+  data.tar.gz: 04f910b8d9d2efb1e1a77a0b1a37ecc83ee8524b6d311d9e1559cb88e1aff6ee5da90ce454a5f9aed20a45aab5b36c5fa5264c2a51e2f4fab407a9d76332b099

data/CHANGELOG.md

@@ -0,0 +1,12 @@
+Changelog
+=========
+
+0.1.1
+-----
+
+- fix bug caused by overwriting `to_json` method
+
+0.1.0
+-----
+
+- First release

data/README.md

@@ -1,4 +1,4 @@
-# Prosperworks::Ruby
+# ProsperWorks-Ruby
 
 A lightweight wrapper for interacting with the [ProsperWorks Developer API](https://www.prosperworks.com/developer_api).
 
@@ -21,7 +21,7 @@ Or install it yourself as:
 
 ## Usage
 
-This gem offers find, search, post and delete operations for the 6 main entity types: People, Companies, Leads, Tasks, Opportunities & Projects. Additionally, it supports the basic create, find, and delete operations for webhooks.
+This gem offers basic operations to interact with the ProsperWorks Developer API. There is minimal error handling and no validation logic.
 
 To use the proper credentials, the following must be run before using the gem:
 
@@ -32,45 +32,68 @@ ProsperWorks.configure do |config|
 end
 ```
 
-To interact with the ProsperWorks API, simply call the relevant entity type and operation:
+### Create
+
+```
+person = ProsperWorks::Person.create(attributes)
+
+opportunity = ProsperWorks::Opportunity.create({
+  pipeline_id: <some_id>,
+  company_id: <another_id>,
+  monetary_value: 1_000
+})
+
+```
+
+### Find
+
+```
+person = ProsperWorks::Person.find(id)
+
+lead = ProsperWorks::Lead.find(423)
+```
+
+### Update
+
+For update, either update the object in advance:
+
+```
+person.name = "A New Name"
+response = ProsperWorks::Person.update(person)
+```
+
+or pass in a hash of attributes to update:
+
+```
+attributes = {
+  name: "A New Name"
+}
+response = ProsperWorks::Person.update(person, attributes)
+
 ```
-  person = ProsperWorks::Person.find(id)
 
-  person = ProsperWorks::Person.create(attributes)
+### Delete
+
+```
+response = ProsperWorks::Person.delete(person.id)
 
-  #
-  # For update, either update the object in advance, or pass
-  # in a hash of attributes to update
-  #
-  person.name = "some new name"
-  response = ProsperWorks::Person.update(person)
-  # --- OR ---
-  response = ProsperWorks::Person.update(person, attributes)
+```
 
-  response = ProsperWorks::Person.delete(person.id)
+### List (webhooks only)
 
+```
+webhooks = ProsperWorks::Webhook.list
 ```
 
 The following entity types are currently supported:
 * Person
 * Lead
-* Companuy
+* Company
 * Opportunity
 * Task
 * Project
 * Webhook
 
-The following operations are currently supported:
-* Create
-* Find
-* Update
-* Delete
-* List (only for webhooks)
-
-```
-webhooks = ProsperWorks::Webhook.list
-```
-
 The response will either be an instance of `ProsperWorks::Errors`, or the entity itself. See the `handle_response` function in [connect.rb](lib/prosperworks/api_operations/connect.rb).
 
 ## Development
@@ -86,20 +109,25 @@ This gem is fairly new, and can benefit from contributions!
 You can take a look at the [issues](https://github.com/soccernee/prosperworks-ruby/issues) and start by contributing there.
 
 Wishlist
-[] continuous integration setup
-[] add [Rubocop](https://github.com/bbatsov/rubocop)
-[] code cleanup & refactoring
-[] improved testing
-[] search endpoint
-[] Users API
-[] Activities API
-[] Related Items API
-[] Secondary Resources APIs
-[] Support for Nested Resources
+- [ ] continuous integration setup
+- [ ] add [Rubocop](https://github.com/bbatsov/rubocop)
+- [ ] code cleanup & refactoring
+- [ ] improved testing
+- [ ] search endpoint
+- [ ] Users API
+- [ ] Activities API
+- [ ] Related Items API
+- [ ] Secondary Resources APIs
+- [ ] Support for Nested Resources
 
 
 Bug reports and pull requests are welcome on GitHub at https://github.com/soccernee/prosperworks-ruby. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
 
+To run the tests:
+```
+rake test
+```
+
 ## License
 
 The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).

data/bin/console

@@ -1,7 +1,7 @@
 #!/usr/bin/env ruby
 
 require "bundler/setup"
-require "prosperworks/ruby"
+require "prosperworks"
 
 # 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.

data/lib/prosperworks/api_operations/connect.rb

@@ -23,10 +23,10 @@ module ProsperWorks
             request = Net::HTTP::Get.new(uri.request_uri, headers)
           when "post"
             request = Net::HTTP::Post.new(uri.request_uri, headers)
-            request.body = entity.to_json
+            request.body = entity.serialize_pw_entity
           when "put"
             request = Net::HTTP::Put.new(uri.request_uri, headers)
-            request.body = entity.to_json
+            request.body = entity.serialize_pw_entity
           when "delete"
             request = Net::HTTP::Delete.new(uri.request_uri, headers)
           end

data/lib/prosperworks/base.rb

@@ -1,6 +1,6 @@
 module ProsperWorks
   class Base
-    include ProsperWorks::JSONable
+    include ProsperWorks::SerializeEntity
 
     attr_accessor :id,
                   :date_created

data/lib/prosperworks/utils.rb

@@ -1,5 +1,4 @@
 require 'json'
-require 'json/add/core' # enables serializing of Time and other things
 
 module ProsperWorks
 
@@ -7,11 +6,10 @@ module ProsperWorks
   # Modified version of the Jsonable gem, all credit goes to the
   # authors of that gem
   #
-  module JSONable
+  module SerializeEntity
 
-    def to_json(*a)
+    def serialize_pw_entity(*a)
       result = {}
-      result['json_class'] = self.class.name
       self.instance_variables.each do |var|
         trimmed_var = var.to_s.gsub!("@", "")
         result[trimmed_var] = self.instance_variable_get var
@@ -21,4 +19,4 @@ module ProsperWorks
 
   end
 
-end
+end

data/lib/prosperworks/version.rb

@@ -1,3 +1,3 @@
 module ProsperWorks
-  VERSION = "0.1.0"
+  VERSION = "0.1.1"
 end

data/prosperworks-ruby.gemspec

@@ -9,7 +9,7 @@ Gem::Specification.new do |spec|
   spec.authors       = ["Neeraj Chandra"]
   spec.email         = ["nchandra324@gmail.com"]
 
-  spec.summary       = %q{A lightweight interface for the ProsperWorks Developer API}
+  spec.summary       = %q{A Ruby gem for the ProsperWorks Developer API}
   spec.description   = %q{A lightweight interface for the ProsperWorks Developer API}
   spec.homepage      = "https://rubygems.org/gems/prosperworks-ruby"
   spec.license       = "MIT"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: prosperworks-ruby
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - Neeraj Chandra
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-07-15 00:00:00.000000000 Z
+date: 2017-08-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -75,6 +75,7 @@ extra_rdoc_files: []
 files:
 - ".gitignore"
 - ".travis.yml"
+- CHANGELOG.md
 - CODE_OF_CONDUCT.md
 - Gemfile
 - LICENSE.txt
@@ -135,5 +136,5 @@ rubyforge_project:
 rubygems_version: 2.6.12
 signing_key: 
 specification_version: 4
-summary: A lightweight interface for the ProsperWorks Developer API
+summary: A Ruby gem for the ProsperWorks Developer API
 test_files: []