limdesk_api 0.0.2 → 0.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 20f13df68d98955d7f47adea62e02b95bb9f5c4a
-  data.tar.gz: 7a228e94c25393b16c9d395ac86edf8100e2033d
+  metadata.gz: 9bde3e1c2acf2d3e2f7729b0a0a6ae9cbb0e2ed8
+  data.tar.gz: b62de19124f071329574232d15eb8c405fe22da0
 SHA512:
-  metadata.gz: f15bcf4626b762787623ae4b1847b19464e3af5e0c3af7eaeb353629bf3f2b6bfdbc39858217aa2e7ff32d1c4dd88d34f743615df3c1cff749288b4e2028c5a5
-  data.tar.gz: 60beb84f48914675c6244c9c3dcb4cf6b4029535a2faf024a47bcd22a1a0088bdb6b5f68fb3f61a5dbe06be555d3fc21684f034e17ed0461770362763a84e909
+  metadata.gz: ac18ac6ba9c3bd79a5a0df8623b865eaadaead371e2c13a287181238b50924f726e3eff1956c7fcced611c98dd74971fcca618419699818556046d0c1cbd32b5
+  data.tar.gz: b89694f0ea6877fc9c49f845ccd17739280e8ac719bc6adca25c8bce4a5af2c547dd15f89cf505c3ec96a52da1b3a4924e062a7cb35e7d81a81bd381ba64732b

data/README.md

@@ -18,9 +18,9 @@ Or install it yourself as:
 
 ## Usage
 
-This gem will allow you to interact with Limdesk API. [Limdesk.com](http://limdesk.com) is a lightweight, multichannel customer support solution. 
+This gem will allow you to interact with Limdesk API. [Limdesk.com](http://limdesk.com) is a lightweight, multichannel customer support solution.
 
-API is available to free and premium users. You can generate your APIKEY in Settings/Integration/API section. 
+API is available to free and premium users. You can generate your APIKEY in Settings/Integration/API section.
 
 This gem wrappes Limdesk API into OpenStruct (RecursiveOpenStruct) objects. For more information about API check the [official docs](http://help.limdesk.com/en/category/458/API_documentation). Current API covers basic, most common actions. More advanced version is currenty under development.
 
@@ -56,7 +56,7 @@ ticket.client.name
 ticket.answer content: 'this is a private comment', answer_type: :priv
 ticket.answer content: 'dear customer, it is solved', answer_type: :pub
 
-ticket.close content: 'its solved', type: :resolved 
+ticket.close content: 'its solved', type: :resolved
 ticket.reopen
 ticket.close content: 'spam', type: :rejected
 
@@ -64,13 +64,13 @@ ticket2 = LimdeskApi::Ticket.create :title => "problem",
                                     :content => "clients probem",
                                     :reported_by => :mail,
                                     :client_id => -1
-                                    
+
 # reported_by can be :mail, :phone, :other, :chat
 # client_id => -1 means "new anonymous clinet"
-                                    
+
 ticket2.title
 "sample ticket 2"
-							
+
 ```
 
 #### Activities
@@ -80,7 +80,7 @@ ticket2.title
 acts = LimdeskApi::Activity.all
 
 act = LimdeskApi::Activity.create content: "client has logged into website",
-                                  client_id: 55 
+                                  client_id: 55
 ```
 
 #### Clients
@@ -93,17 +93,26 @@ cls = LimdeskApi::Client.all
 cls.first.name
 "John Smith"
 
-client = LimdeskApi::Client.create  name: "John Smith", 
+client = LimdeskApi::Client.create  name: "John Smith",
                                     nippesel: "15012406496",
                                     phone: "223111789",
                                     email: "email@example.com",
-                                    adress: "Plain Street 149 85-058 Warsaw"
+                                    address: "Plain Street 149 85-058 Warsaw"
 client.delete!
 true
 
 client2 = LimdeskApi::Client.get(55)
 client2.contacts.first
 
+client2.update name: "John Smith 2",
+               nippesel: "123",
+               phone: "11111",
+               email: "emailnew@example.com",
+               address: "Plain Street 149 85-058 Warsaw"
+true
+
+client3 = LimdeskApi::Client.get_by_email('adam@example.com')
+client4 = LimdeskApi::Client.get_by_phone('+48897228989')
 ```
 
 #### Sales

data/lib/limdesk_api/client.rb

@@ -14,5 +14,47 @@ module LimdeskApi
     def self.create(params)
       super
     end
+
+    # Gets a Client by property
+    #
+    # @param [String] action search type
+    # @param [String] query search data
+    #
+    # @return [LimdeskApi::Client]
+    def self.get_by(action, query)
+      response = LimdeskApi.get_one object: object_symbol,
+                                    action: action,
+                                    query: query
+      response ? new(response) : nil
+    end
+
+    # Gets a Client by e-mail
+    #
+    # @param [String] email find by e-mail
+    #
+    # @return [LimdeskApi::Client]
+    def self.get_by_email(email)
+      get_by('get_by_email', email)
+    end
+
+    # Gets a Client by phone
+    #
+    # @param [String] phone find by phone
+    #
+    # @return [LimdeskApi::Client]
+    def self.get_by_phone(phone)
+      get_by('get_by_phone', phone)
+    end
+
+    # updates a client
+    #
+    # @param [Hash] params new client data
+    #
+    # @return [LimdeskApi::Client]
+    def update(params)
+      LimdeskApi.put object: object_symbol,
+                     params: params,
+                     id: id
+    end
   end
 end

data/lib/limdesk_api/limdesk_object.rb

@@ -10,8 +10,8 @@ module LimdeskApi
     # @return [LimdeskApi::Client]
     # @return [LimdeskApi::Sale]
     def self.get(id)
-      response = LimdeskApi.get_one(object: self.object_symbol, id: id)
-      response ? self.new(response) : nil
+      response = LimdeskApi.get_one(object: object_symbol, id: id)
+      response ? new(response) : nil
     end
 
     # Creates an object by LimdeskAPI
@@ -22,8 +22,8 @@ module LimdeskApi
     # @return [LimdeskApi::Client]
     # @return [LimdeskApi::Sale]
     def self.create(params)
-      response = LimdeskApi.create(object: self.object_symbol, params: params)
-      self.new response
+      response = LimdeskApi.create(object: object_symbol, params: params)
+      new response
     end
 
     # Gets all objects of a type from LimdeskAPI
@@ -33,13 +33,13 @@ module LimdeskApi
     # @return [Array<LimdeskApi::Sale>]
     # @return [Array<LimdeskApi::Activity>]
     def self.all
-      LimdeskApi.get_all(self.object_symbol).map { |obj| self.new obj }
+      LimdeskApi.get_all(object_symbol).map { |obj| new obj }
     end
 
     # Helper - get class name as a symbol
     # @return [Symbol]
     def self.object_symbol
-      self.name.downcase.split(':').last.to_sym
+      name.downcase.split(':').last.to_sym
     end
 
     # Force object to refresh itself from LimdeskAPI
@@ -48,7 +48,7 @@ module LimdeskApi
     # @return [LimdeskApi::Client]
     # @return [LimdeskApi::Sale]
     def refresh!
-      self.marshal_load(self.class.get(self['id']).marshal_dump)
+      marshal_load(self.class.get(self['id']).marshal_dump)
     end
 
     # Delete an object by LimdeskAPI

data/lib/limdesk_api/ticket.rb

@@ -37,7 +37,7 @@ module LimdeskApi
     # Refreshes the object from the server
     # @return [LimdeskApi::Ticket]
     def refresh!
-      self.marshal_load(Ticket.get(self['number']).marshal_dump)
+      marshal_load(Ticket.get(self['number']).marshal_dump)
     end
 
     # Closes a ticket
@@ -66,7 +66,7 @@ module LimdeskApi
     # @return [Boolean]
     def reopen
       response = LimdeskApi.put(
-        id: self.number,
+        id: number,
         object: :ticket,
         action: :reopen,
         params: {})
@@ -85,7 +85,7 @@ module LimdeskApi
       fail 'BadAnswerType' unless Ticket::ANSWER_TYPES.keys.include?(params[:answer_type])
       params['type'] = Ticket::ANSWER_TYPES[params.delete(:answer_type)]
       response = LimdeskApi.post_simple(
-        id: self.number,
+        id: number,
         object: :ticket,
         action: :answer,
         params: params)

data/lib/limdesk_api/version.rb

@@ -1,3 +1,3 @@
 module LimdeskApi
-  VERSION = '0.0.2'
+  VERSION = '0.0.3'
 end

data/lib/limdesk_api.rb

@@ -69,6 +69,7 @@ module LimdeskApi
     resp = @connection.get do |req|
       req.url generate_url params
       req.params[:key] = @key
+      req.params[:query] = params[:query] if params[:query]
     end
     case resp.status
     when 200
@@ -181,14 +182,14 @@ module LimdeskApi
   end
 
   def self.put(params)
-    self.update(:put, params)
+    update(:put, params)
   end
 
   def self.post_simple(params)
-    self.update(:post, params)
+    update(:post, params)
   end
 
   def self.delete(params)
-    self.update(:delete, params)
+    update(:delete, params)
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: limdesk_api
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.3
 platform: ruby
 authors:
 - Grzegorz Siehień
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-11-03 00:00:00.000000000 Z
+date: 2014-11-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler