knackhq-client 0.1.1 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 94825773af2c61878dc4ba69bb6447e920e195d4
-  data.tar.gz: ef3535920cc26652c8dbaf265ae32470cf828399
+  metadata.gz: 0337d53689c433e99665facab6e5e64514ae31e7
+  data.tar.gz: ba92265868729d27ab8def0c31535359c610b17e
 SHA512:
-  metadata.gz: 74f117f2e7ad9376d0f77f86598ee12d13aa60992192fc914ddb99fd99ddafd4c79f88577bb32fe271809058fe5c8254716f1a50939bdfa25e7b306466454972
-  data.tar.gz: d81ee0e01c641a2991599957ec98fc8982a2fc938e01122241f4d28edeff800ab268712e377005407832f3d6fdf265692518f39a8c0cb2a308805e298987e506
+  metadata.gz: ceb159c096f87ce1e6c3472f784f7a6f60e828e5c1759b1fc6f9be015d661b9e3c19b632ceb9cececcfb8fd7824f9eaea1d1f595f06cf22b44394749f5bc28e0
+  data.tar.gz: fb6b2ab515bb757fe1c13c52485c3c016e5d63164a0980e8d895076e2136a65e22c28eb4be46edcfcdb87a31aa005e87bb2f9d4c654be8b54d4ae8e1b79e13ed

data/Gemfile.lock

@@ -1,16 +1,16 @@
 PATH
   remote: .
   specs:
-    knackhq-client (0.1.1)
-      blanket_wrapper (~> 1.1.0)
+    knackhq-client (0.2.0)
+      blanket_wrapper (~> 2.0.1)
       hashie
       rest-client
 
 GEM
   remote: https://rubygems.org/
   specs:
-    addressable (2.3.7)
-    blanket_wrapper (1.1.0)
+    addressable (2.3.8)
+    blanket_wrapper (2.0.1)
       httparty
       recursive-open-struct
     codeclimate-test-reporter (0.4.7)
@@ -33,7 +33,7 @@ GEM
     multi_xml (0.5.5)
     netrc (0.10.3)
     rake (10.4.2)
-    recursive-open-struct (0.6.1)
+    recursive-open-struct (0.6.3)
     rest-client (1.8.0)
       http-cookie (>= 1.0.2, < 2.0)
       mime-types (>= 1.16, < 3.0)
@@ -42,9 +42,9 @@ GEM
       rspec-core (~> 3.2.0)
       rspec-expectations (~> 3.2.0)
       rspec-mocks (~> 3.2.0)
-    rspec-core (3.2.1)
+    rspec-core (3.2.3)
       rspec-support (~> 3.2.0)
-    rspec-expectations (3.2.0)
+    rspec-expectations (3.2.1)
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.2.0)
     rspec-its (1.2.0)
@@ -78,5 +78,6 @@ DEPENDENCIES
   rake (~> 10.0)
   rspec (~> 3.2.0)
   rspec-its (~> 1.2.0)
+  simplecov (~> 0.9.0)
   vcr (~> 2.9.0)
   webmock (~> 1.20.0)

data/README.md

@@ -22,30 +22,34 @@ Or install it yourself as:
 api = Knackhq::Client.new('knack-api-url',
                     x_knack_application_id,
                     x_knack_rest_api_key)
-#GETs the request.
-api.request.get
 
 #GET all objects in api.
 api.objects
+#Output:
+[{:name=>"Foo", :key=>"object_1"}
+{:name=>"Bar", :key=>"object_2"}]
 
 #GET object_1 fields
 api.fields('object_1')
+#Output:
+[{:label=>"Number", :key=>"field_1", :type=>"float", :required=>false, :field_type=>"number"},
+{:label=>"Last Date", :key=>"field_12", :type=>"datetime", :required=>false, :field_type=>"date_time"}]
 
 #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')
+#Output:
+{:total_pages=>2, :current_page=>1, :total_records=>28, :records=>[{:id=>"23456", :account_status=>"active", :approval_status=>"approved", :profile_keys=>"Bar", :profile_keys_raw=>[{:id=>"12345", :identifier=>"Bar"}], :field_32=>"First Name", :field_32_raw=>{:last=>"Last", :first=>"First"}, :field_33=>"<a href=\"mailto:flast@example.com\">flast@example.com</a>", :field_33_raw=>{:email=>"flast@example.com"}, :field_34=>"*********", :field_34_raw=>"**********", :field_188=>"<span class=\"23456\">Bar</span>", :field_188_raw=>[{:id=>"23456", :identifier=>"Bar"}]}]}
 
 #GET object_1
 api.object('object_1')
+#Output
+{:id=>"34567", :default=>"", :key=>"field_1", :name=>"Foo", :rules=>[], :conditional=>false, :user=>false, :unique=>true, :required=>true, :immutable=>false, :type=>"short_text"}
 
 #PUT object_1 record
 #Knackhq ID is 12345
 api.update_record('object_1', '12345', { field_name: value }.to_json)
+#Output:
+true/false
 ```
 
 ## Contributing

data/knackhq-client.gemspec

@@ -20,7 +20,7 @@ Gem::Specification.new do |spec|
   spec.executables = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ['lib']
 
-  spec.add_dependency 'blanket_wrapper', '~> 1.1.0'
+  spec.add_dependency 'blanket_wrapper', '~> 2.0.1'
   spec.add_dependency 'rest-client'
   spec.add_dependency 'hashie'
   spec.add_development_dependency 'bundler', '~> 1.7'
@@ -30,4 +30,5 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency 'rspec-its', '~> 1.2.0'
   spec.add_development_dependency 'vcr', '~> 2.9.0'
   spec.add_development_dependency 'webmock', '~> 1.20.0'
+  spec.add_development_dependency 'simplecov', '~> 0.9.0'
 end

data/lib/knackhq/client.rb

@@ -16,53 +16,37 @@ module Knackhq
       hash_request = request
                      .objects
                      .get
-                     .to_h[:objects]
-      return [] if hash_request.empty?
-      symbolize_hash_keys!(hash_request)
+      payload = payload_hash(hash_request)
+      translate_payload(payload) { payload[:objects] }
     end
 
     def object(key)
-      hash_request = request.objects.get(key).to_h
-      return [] if hash_request.empty?
-      transform_hash_keys = hash_request[:object]['fields']
-      symbolize_hash_keys!(transform_hash_keys)
+      hash_request = request
+                     .objects
+                     .get(key)
+      payload = payload_hash(hash_request)
+      translate_payload(payload) { payload[:object][:fields] }
     end
 
     def fields(object)
-      hash_request = request_object(object, :fields)
-      return [] if hash_request.empty?
-      transform_hash_keys = hash_request[:fields]
-      symbolize_hash_keys!(transform_hash_keys)
-    end
-
-    def records(object)
-      hash_request = request_object(object, :records)
-      return [] if hash_request.empty?
-      transform_hash_keys = hash_request[:records]
-      symbolize_hash_keys!(transform_hash_keys)
-    end
-
-    def records_by_page(object, page_number)
       hash_request = request
                      .objects(object)
-                     .records
-                     .get(:params => { :page => page_number,
-                                       :rows_per_page => 500 })
-                     .to_h
-      return [] if hash_request.empty?
-      transform_hash_keys = hash_request[:records]
-      symbolize_hash_keys!(transform_hash_keys)
+                     .fields
+                     .get
+      payload = payload_hash(hash_request)
+      translate_payload(payload) { payload[:fields] }
     end
 
-    def records_info(object)
+    def records(object, options = {})
+      rows_per_page = options[:rows_per_page] || 25
+      page_number = options[:page_number] || 1
       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]
+                     .get(:params => { :page => page_number,
+                                       :rows_per_page => rows_per_page })
+      payload = payload_hash(hash_request)
+      translate_payload(payload) { payload }
     end
 
     def update_record(object, knackhq_id, json)
@@ -70,8 +54,7 @@ module Knackhq
                      .objects(object)
                      .records(knackhq_id)
                      .put(:body => json)
-                     .to_h
-      !hash_request.empty?
+      !payload_hash(hash_request).empty?
     end
 
     private
@@ -84,14 +67,14 @@ module Knackhq
                    :headers => headers)
     end
 
-    def request_object(object, function)
-      request.objects(object).send(function).get.to_h
+    def payload_hash(hash_request)
+      payload = hash_request.first.to_h
+      Hashie.symbolize_keys!(payload)
     end
 
-    def symbolize_hash_keys!(transform_hash_keys)
-      transform_hash_keys.map do |hash|
-        Hashie.symbolize_keys!(hash)
-      end
+    def translate_payload(payload, &block)
+      return [] if payload.empty?
+      block.call
     end
   end
 end

data/lib/knackhq/client/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: knackhq-client
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.2.0
 platform: ruby
 authors:
 - MichaelAChrisco
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2015-04-09 00:00:00.000000000 Z
+date: 2015-04-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: blanket_wrapper
@@ -16,14 +16,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.1.0
+        version: 2.0.1
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.1.0
+        version: 2.0.1
 - !ruby/object:Gem::Dependency
   name: rest-client
   requirement: !ruby/object:Gem::Requirement
@@ -150,6 +150,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 1.20.0
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.9.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.9.0
 description: Knackhq.com API client
 email:
 - michaelachrisco@gmail.com
@@ -192,7 +206,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.6
+rubygems_version: 2.4.3
 signing_key: 
 specification_version: 4
 summary: Knackhq.com API client