knackhq-client 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: eb73a625e3e61bfc57e2bc26626bc395a766f8ef
-  data.tar.gz: 3a22ab9bf2374deb31cff019b4019e6427c0f65a
+  metadata.gz: 94825773af2c61878dc4ba69bb6447e920e195d4
+  data.tar.gz: ef3535920cc26652c8dbaf265ae32470cf828399
 SHA512:
-  metadata.gz: 4555f157245b024e570191eedd4ea99d7db48280d4a63d1e5b254848f7fdadceaf1da88716b8931a9504c0c98b309367f10a09ae968f8a87f1351ab7c0340404
-  data.tar.gz: 92532b355e882ace85b8e5d75839abf47ed3d0e1fe7e8a2b32290378d8e9bd19f738b0e9a29ca80fe10b05f5f6fd31b955f89ad9e81a6b8cd3cf9a91b81fae72
+  metadata.gz: 74f117f2e7ad9376d0f77f86598ee12d13aa60992192fc914ddb99fd99ddafd4c79f88577bb32fe271809058fe5c8254716f1a50939bdfa25e7b306466454972
+  data.tar.gz: d81ee0e01c641a2991599957ec98fc8982a2fc938e01122241f4d28edeff800ab268712e377005407832f3d6fdf265692518f39a8c0cb2a308805e298987e506

data/.gitignore

@@ -1,6 +1,5 @@
 /.bundle/
 /.yardoc
-/Gemfile.lock
 /_yardoc/
 /coverage/
 /doc/

data/Gemfile.lock

@@ -0,0 +1,82 @@
+PATH
+  remote: .
+  specs:
+    knackhq-client (0.1.1)
+      blanket_wrapper (~> 1.1.0)
+      hashie
+      rest-client
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    addressable (2.3.7)
+    blanket_wrapper (1.1.0)
+      httparty
+      recursive-open-struct
+    codeclimate-test-reporter (0.4.7)
+      simplecov (>= 0.7.1, < 1.0.0)
+    crack (0.4.2)
+      safe_yaml (~> 1.0.0)
+    diff-lcs (1.2.5)
+    docile (1.1.5)
+    domain_name (0.5.23)
+      unf (>= 0.0.5, < 1.0.0)
+    hashie (3.4.1)
+    http-cookie (1.0.2)
+      domain_name (~> 0.5)
+    httparty (0.13.3)
+      json (~> 1.8)
+      multi_xml (>= 0.5.2)
+    json (1.8.2)
+    mime-types (2.4.3)
+    multi_json (1.11.0)
+    multi_xml (0.5.5)
+    netrc (0.10.3)
+    rake (10.4.2)
+    recursive-open-struct (0.6.1)
+    rest-client (1.8.0)
+      http-cookie (>= 1.0.2, < 2.0)
+      mime-types (>= 1.16, < 3.0)
+      netrc (~> 0.7)
+    rspec (3.2.0)
+      rspec-core (~> 3.2.0)
+      rspec-expectations (~> 3.2.0)
+      rspec-mocks (~> 3.2.0)
+    rspec-core (3.2.1)
+      rspec-support (~> 3.2.0)
+    rspec-expectations (3.2.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.2.0)
+    rspec-its (1.2.0)
+      rspec-core (>= 3.0.0)
+      rspec-expectations (>= 3.0.0)
+    rspec-mocks (3.2.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.2.0)
+    rspec-support (3.2.2)
+    safe_yaml (1.0.4)
+    simplecov (0.9.2)
+      docile (~> 1.1.0)
+      multi_json (~> 1.0)
+      simplecov-html (~> 0.9.0)
+    simplecov-html (0.9.0)
+    unf (0.1.4)
+      unf_ext
+    unf_ext (0.0.6)
+    vcr (2.9.3)
+    webmock (1.20.4)
+      addressable (>= 2.3.6)
+      crack (>= 0.3.2)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.7)
+  codeclimate-test-reporter
+  knackhq-client!
+  rake (~> 10.0)
+  rspec (~> 3.2.0)
+  rspec-its (~> 1.2.0)
+  vcr (~> 2.9.0)
+  webmock (~> 1.20.0)

data/README.md

@@ -1,5 +1,5 @@
 # Knackhq::Client
-
+[![Gem Version](https://badge.fury.io/rb/knackhq-client.svg)](http://badge.fury.io/rb/knackhq-client) [![Build Status](https://travis-ci.org/westernmilling/knackhq-client.svg?branch=master)](https://travis-ci.org/westernmilling/knackhq-client) [![Dependency Status](https://gemnasium.com/westernmilling/knackhq-client.svg)](https://gemnasium.com/westernmilling/knackhq-client) [![Code Climate](https://codeclimate.com/github/westernmilling/knackhq-client/badges/gpa.svg)](https://codeclimate.com/github/westernmilling/knackhq-client)
 ## Installation
 
 Add this line to your application's Gemfile:
@@ -24,11 +24,28 @@ api = Knackhq::Client.new('knack-api-url',
                     x_knack_rest_api_key)
 #GETs the request.
 api.request.get
+
 #GET all objects in api.
-api.all_objects
+api.objects
+
+#GET object_1 fields
+api.fields('object_1')
+
+#GET object_1 records
+api.records('object_1')
+
+#GET object_1 records by page
+api.records_by_page('object_1')
+
+#Get object_1 info on records
+api.records_info('object_1')
+
 #GET object_1
 api.object('object_1')
 
+#PUT object_1 record
+#Knackhq ID is 12345
+api.update_record('object_1', '12345', { field_name: value }.to_json)
 ```
 
 ## Contributing

data/knackhq-client.gemspec

@@ -24,6 +24,7 @@ Gem::Specification.new do |spec|
   spec.add_dependency 'rest-client'
   spec.add_dependency 'hashie'
   spec.add_development_dependency 'bundler', '~> 1.7'
+  spec.add_development_dependency 'codeclimate-test-reporter'
   spec.add_development_dependency 'rake', '~> 10.0'
   spec.add_development_dependency 'rspec', '~> 3.2.0'
   spec.add_development_dependency 'rspec-its', '~> 1.2.0'

data/lib/knackhq/client.rb

@@ -13,49 +13,67 @@ module Knackhq
     end
 
     def objects
-      hash_request = request.objects.get.to_h[:objects]
-      hash_request.map { |hash| symbolize_hash_keys(hash) }
+      hash_request = request
+                     .objects
+                     .get
+                     .to_h[:objects]
+      return [] if hash_request.empty?
+      symbolize_hash_keys!(hash_request)
     end
 
     def object(key)
       hash_request = request.objects.get(key).to_h
       return [] if hash_request.empty?
       transform_hash_keys = hash_request[:object]['fields']
-
-      transform_hash_keys.map { |hash| symbolize_hash_keys(hash) }
+      symbolize_hash_keys!(transform_hash_keys)
     end
 
     def fields(object)
-      hash_request = request.objects(object).fields.get.to_h
+      hash_request = request_object(object, :fields)
       return [] if hash_request.empty?
       transform_hash_keys = hash_request[:fields]
-      transform_hash_keys.map { |hash| symbolize_hash_keys(hash) }
+      symbolize_hash_keys!(transform_hash_keys)
     end
 
     def records(object)
-      hash_request = request.objects(object).records.get.to_h
+      hash_request = request_object(object, :records)
       return [] if hash_request.empty?
       transform_hash_keys = hash_request[:records]
-      transform_hash_keys.map { |hash| symbolize_hash_keys(hash) }
+      symbolize_hash_keys!(transform_hash_keys)
     end
 
     def records_by_page(object, page_number)
-      hash_request = request.objects(object).records
+      hash_request = request
+                     .objects(object)
+                     .records
                      .get(:params => { :page => page_number,
-                                       :rows_per_page => 500 }).to_h
+                                       :rows_per_page => 500 })
+                     .to_h
       return [] if hash_request.empty?
       transform_hash_keys = hash_request[:records]
-      transform_hash_keys.map { |hash| symbolize_hash_keys(hash) }
+      symbolize_hash_keys!(transform_hash_keys)
     end
 
     def records_info(object)
-      hash_request = request.objects(object).records
-                     .get(:params => { :rows_per_page => 500 }).to_h
+      hash_request = request
+                     .objects(object)
+                     .records
+                     .get(:params => { :rows_per_page => 500 })
+                     .to_h
       return [] if hash_request.empty?
       hash_request.delete(:records)
       [hash_request]
     end
 
+    def update_record(object, knackhq_id, json)
+      hash_request = request
+                     .objects(object)
+                     .records(knackhq_id)
+                     .put(:body => json)
+                     .to_h
+      !hash_request.empty?
+    end
+
     private
 
     def request
@@ -66,8 +84,14 @@ module Knackhq
                    :headers => headers)
     end
 
-    def symbolize_hash_keys(value)
-      Hashie.symbolize_keys!(value)
+    def request_object(object, function)
+      request.objects(object).send(function).get.to_h
+    end
+
+    def symbolize_hash_keys!(transform_hash_keys)
+      transform_hash_keys.map do |hash|
+        Hashie.symbolize_keys!(hash)
+      end
     end
   end
 end

data/lib/knackhq/client/version.rb

@@ -1,5 +1,5 @@
 module Knackhq
   class Client
-    VERSION = '0.1.0'
+    VERSION = '0.1.1'
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: knackhq-client
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - MichaelAChrisco
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2015-03-27 00:00:00.000000000 Z
+date: 2015-04-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: blanket_wrapper
@@ -66,6 +66,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.7'
+- !ruby/object:Gem::Dependency
+  name: codeclimate-test-reporter
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -149,6 +163,7 @@ files:
 - ".travis.yml"
 - CODE_OF_CONDUCT.md
 - Gemfile
+- Gemfile.lock
 - LICENSE.txt
 - README.md
 - Rakefile
@@ -177,9 +192,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.3
+rubygems_version: 2.4.6
 signing_key: 
 specification_version: 4
 summary: Knackhq.com API client
 test_files: []
-has_rdoc: