gmail-api-ruby 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 24b38375594da2fabd46ccde5cb098b9d5cfebc9
-  data.tar.gz: d67652090a269c623f7930ae74660f3b56813d7a
+  metadata.gz: 03481cc395ab2eb88fa4f90aef5ac3e5368ad2fc
+  data.tar.gz: cbf0ec27698b435a7ddd72c8f70c47f51b74bff0
 SHA512:
-  metadata.gz: 286c48ccfce4c9551296e2d24fd44e13654fbad378295502e3ddae54ab18b5afae1224bdd34adc2772fe72c3810b94493f4e9f446b0b7dae531c502e4ba48198
-  data.tar.gz: 573ca19b9f5f4ffcc8bdd272a6a86d5d0ab21d7414f0bc36ff4f070a343b1ef5fc8a412d1509d4fc582bc7cad65fd0dfa75e8ae83a4791b520a48c65d98c957c
+  metadata.gz: 257b9bbb2719a1260d9023e9508cbeac3a670f7875afbd9eb3e41affd32d64ec66c60c4addfdd44c426312536ff7b746da3ab98755b8fc9b8b27bc547672b55f
+  data.tar.gz: 3047e7203b0ba52a79fffec5fc2a8d986690bc1823e3027d8a295c836ff4e30542561c9e0155c617a133a7193ea97fd331ffbcd402bb5d2bc450cd20035ed0c7

data/.gitignore

@@ -23,12 +23,10 @@ pkg
 Gemfile.lock
 
 ## Gem build
-.gem
+*.gem
 
 ## PROJECT::SPECIFIC
 *.rdb
 
 ## Test Account details
-spec/account.yml
-env.yml
-spec/
+account.yml

data/CHANGELOG.md

@@ -1,4 +1,4 @@
-# Gmail gem changelog
+# gmail-api-ruby gem changelog
 ## 0.0.1 / 2015-01
 
 * Birthday!

data/README.md

@@ -8,38 +8,47 @@ and manage labels. Everything goes through Gmail API (and not throught IMAP or S
 
 If for your usecase, the gem is too limited there are two solutions for you:
 
-1- Contribute ;)
-2- Look at Gmail Api doc (https://developers.google.com/gmail/api/v1/reference) to:
-    *Do custom query by adding parameters I didn't talk about in my doc
-    *If for some reason I forgot to build some methods, note that you can call fully custom request via Gmail.client (Standard Google Api Client)
+1. Contribute ;)
+2. Look at [Gmail Api doc](https://developers.google.com/gmail/api/v1/reference) to:
+    * Do custom query by adding parameters I didn't talk about in my doc
+    * If for some reason I forgot to build some methods, note that you can call fully custom request via Gmail.client (Standard Google Api Client)
 
 # To Do
 
-Write test
-write proper error handling
+* write proper error handling
 
 ## Installation
 
-    gem install gmail-ruby-api
+    gem install gmail-api-ruby
 
-## initialisation
+## Initialization
 
+```ruby
     Gmail.client_id = "...Your app client id..."
     Gmail.client_secret = "...Your app Secret..."
     Gmail.refresh_token = "...the refresh token of the Gmail account you want to use..."
+```
 
 ## Usage
 
+```ruby
     require "Gmail"
+```
 
 ### Common methods
 
 this works for Messages, Labels, Drafts and Threads (everything)
+
+```ruby
    Gmail::Message.all
    Gmail::Message.all(maxResults: -1) #will parse everything. Use with care. Can through request timeout if used in web apps
    Gmail::Message.get(message_id)
    some_gmail_message.delete
+```
+
 this will work for Messages and Threads
+
+```ruby
    some_message.archive
    some_message.un_archive
    some_message.trash
@@ -48,24 +57,28 @@ this will work for Messages and Threads
    some_message.un_star
    some_message.mark_as_read
    some_message.mark_as_unread
-
+   
    Gmail::Message.search(in: "labelId" from: "me@gmail.com", to: "you@gmail.com, theothers@gmail.com", subject: "some subject", after: "date", before: "date", has_words: "some words", has_not_words: "some text")
    Gmail::Message.search("some words") #search as you would do in gmail interface
-
+ 
+ ```
 
 
 ### Message
 
 Create a Message object
 
+```ruby
     m = Gmail::Message.new(
         from: "test@test.com",
         to: "hello@world.com",
         subject: "this is the subject",
         body: "this is a text body")
+```
 
 If you want a multipart message
 
+```ruby
     m = Gmail::Message.new(
         from: "test@test.com",
         to: "hello@world.com",
@@ -74,14 +87,19 @@ If you want a multipart message
         html: "<div>this is a html body</div>",
         labelIds: ["cool label", "Newsletter"] #labelIds is always array of labels
         )
+```
 
 From this you can create a Draft in Gmail
 
+```ruby
     m.create_draft
+```
 
 or just send the Message
 
+```ruby
     m.deliver
+```
 
 Notice that the Message object can use from, to, cc, bcc, threadId, labelIds, text, html, body
 
@@ -90,20 +108,25 @@ Or if you need to create a different multipart email, you need to build the "raw
 
 example:
 
+```ruby
     mail = Mail.new #this is the native ruby Mail object
     #
     # construct your Mail object
     #
     raw = Base64.urlsafe_encode64 mail.to_s
     m = Gmail::Message.new(raw: raw)
+```
 
 In that scenario, you still assign, if needed, ThreadId and labelIds as previously
 
+```ruby
     m.threadId = "somethreadId"
     m.labelIds = ["cool label"]
+```
 
 If you want to quickly generate a reply or a forward to message
 
+```ruby
     # this will handle everything for you, keeping the subject the thread etc as it would happen in Gmail
       # reply only to the sender of Message m.
         m.reply_sender_with Gmail::Message.new(body: "some reply text")
@@ -111,14 +134,17 @@ If you want to quickly generate a reply or a forward to message
         m.reply_all_with Gmail::Message.new(body: "some reply text")
       # forward
         m.forward_with Gmail::Message.new(body: "some forward text", to: "address@toforward.com")
+```
 
 Other stuffs that you can do with Message object
 
+```ruby
     m.detailed #if for any reason Google did send us the full detail of on email object
     m.thread #to get the associated Thread
     m.inbox? #to know if email is in inbox
     m.sent? #to know if email is a sent email
     m.unread? #to know if email is unread
+```
 
 Those are basics helpers feel free to add more if you want (ex: starred?, important?, etc)
 
@@ -126,73 +152,101 @@ Those are basics helpers feel free to add more if you want (ex: starred?, import
 ## Thread
 
 Get a thread
+
+```ruby
    one_thread = Gmail::Thread.get(thread_id)
+```
+
 or
+
+```ruby
    one_thread = one_message.thread
+```
 
 Filter messages in Thread
 
+```ruby
    one_thread.unread_messages
    one_thread.sent_messages
+```
 
 Expand messages in Thread
 
+```ruby
    one_thread.detailed #this will return a thread object but with all messages detailed
    one_thread.messages #this will return an array of message objects
+```
 
 ## Draft
 
 As we explained in Message, you create a draft with
 
+```ruby
     d = some_message.create_draft
+```
 
 Modify it with
 
+```ruby
     d.message.subject = "some different subject than before"
     d.save
+```
 
 send it with
 
+```ruby
     d.deliver
+```
 
 ## Label
 
 You can create a label like this:
 
+```ruby
     l = Gmail::Label.new
     l.name = "different Name"
     l.messageListVisibility = "hide" #can be 'hide' or 'show'
     l.labelListVisibility = "labelShowIfUnread" #can be "labelShowIfUnread", "labelShow", "labelHide"
     l.save
+```
 
 You can modify a label like this:
 
+```ruby
     l = Gmail::Label.get("labelId")
     l.name = "different Name"
     l.messageListVisibility = "hide"
     l.labelListVisibility = "labelShowIfUnread"
     l.save
+```
 
 You can use Labels to directly access box information
 
+```ruby
     l.detailed #will display number of messages and number of threads if you don't see it
+```
 
 For system labels like inbox, sent, trash, important, starred, draft, spam, unread, category_updates, category_promotions, category_social, category_personal, category_forums
 
+```ruby
     l = Gmail::Label.inbox
+```
 
 Access threads and messages from labels
 
+```ruby
     l.threads
     l.messages
 
     l.unread_threads
     l.unread_messages
+```
 
 Access threads, drafts and messages with labels
 
+```ruby
     Gmail::Message.all(labelIds: ["UNREAD", "INBOX"])
-
+```
 
 ## License
 

data/Rakefile

@@ -23,13 +23,10 @@ end
 
 Bundler::GemHelper.install_tasks
 
-begin
-  require 'rspec/core/rake_task'
-  RSpec::Core::RakeTask.new(:spec)
-rescue LoadError
-  task :spec do
-    abort 'Run `gem install rspec` to install RSpec'
-  end
-end
+require 'rake/testtask'
+
+task :default => [:test]
 
-task :default => :spec
+Rake::TestTask.new do |t|
+  t.pattern = './test/**/*_test.rb'
+end

data/TODO.md

@@ -1,4 +1,3 @@
 # TODO
 
-*proper errors handling
-*write test
+*proper errors handling

data/account.yml.example

@@ -0,0 +1,5 @@
+client_id: example
+client_secret: example
+refresh_token: example
+application_name: example
+application_version: 1.0.0

data/gmail.gemspec

@@ -24,8 +24,9 @@ Gem::Specification.new do |s|
   
   # development dependencies
   s.add_development_dependency "rake"
-  s.add_development_dependency "rspec", "~> 2.0"
-  s.add_development_dependency "mocha", ">= 0.9"
+  s.add_development_dependency "test-unit"
+  s.add_development_dependency('mocha', '~> 0.13.2')
+  s.add_development_dependency('shoulda', '~> 3.4.0')
   s.add_development_dependency "gem-release"
   
   s.files         = `git ls-files`.split("\n")

data/lib/gmail.rb

@@ -1,6 +1,4 @@
 require 'mail'
-require 'date'
-require 'time'
 require 'hashie'
 require 'hooks'
 require 'google/api_client'
@@ -25,16 +23,24 @@ require 'gmail/label'
 
 
 module Gmail
-  begin
-    @client_id ||= YAML.load_file("env.yml")["GOOGLE_CLIENT_ID"]
-    @client_secret ||= YAML.load_file("env.yml")["GOOGLE_CLIENT_SECRET"]
-    @refresh_token ||= YAML.load_file("env.yml")["GOOGLE_REFRESH_TOKEN"]
-  rescue
 
+  class << self
+    attr_accessor :client_id, :client_secret, :refresh_token, :client, :service, :application_name, :application_version
+    def new hash
+      [:client_id, :client_secret, :refresh_token, :application_name, :application_version].each do |accessor|
+        Gmail.send("#{accessor}=", hash[accessor.to_s])
+      end
+    end
   end
 
-  class << self
-    attr_accessor :client_id, :client_secret, :refresh_token, :client, :service
+  Google::APIClient.logger.level = 3
+  @service = Google::APIClient.new.discovered_api('gmail', 'v1')
+  Google::APIClient.logger.level = 2
+
+  begin
+    Gmail.new  YAML.load_file("account.yml")  # for development purpose
+  rescue
+
   end
 
   def self.request(method, params={}, body={})
@@ -74,23 +80,23 @@ module Gmail
     end
 
     @client = Google::APIClient.new(
-        application_name: 'Juliedesk',
-        application_version: '1.0.0'
+        application_name: @application_name,
+        application_version: @application_version
     )
     @client.authorization.client_id = client_id
     @client.authorization.client_secret = client_secret
     @client.authorization.refresh_token = refresh_token
     @client.authorization.grant_type = 'refresh_token'
     @client.authorization.fetch_access_token!
+    @client.auto_refresh_token = true
 
-    @service = @client.discovered_api('gmail', 'v1')
+    #@service = @client.discovered_api('gmail', 'v1')
 
   end
 
   def self.parse(response)
     begin
-      # Would use :symbolize_names => true, but apparently there is
-      # some library out there that makes symbolize_names not work.
+
       if response.body.empty?
         return response.body
       else

data/lib/gmail/api_resource.rb

@@ -5,7 +5,6 @@ module Gmail
     end
 
     def self.base_method
-      Gmail.connect
       Gmail.service.users.send("#{class_name.downcase}s")
     end
 

data/lib/gmail/base/delete.rb

@@ -4,7 +4,9 @@ module Gmail
       def delete(opts={})
         response = Gmail.request(self.class.base_method.send("delete"),{id: id})
         if response == ""
-          p "Success"
+          true
+        else
+          false
         end
       end
 
@@ -12,7 +14,9 @@ module Gmail
         def delete(id, opts={})
          response = Gmail.request(base_method.send("delete"),{id: id})
          if response == ""
-           p "Success"
+           true
+         else
+           false
          end
         end
       end

data/lib/gmail/base/list.rb

@@ -29,15 +29,19 @@ module Gmail
             query = ""
             [:from, :to, :subject].each do |prop|
               query += "#{prop.to_s}:(#{q[prop].downcase}) "  unless q[prop].nil?
+              q.delete(prop)
             end
             [:in, :before, :after].each do |prop|
               query += "#{prop.to_s}:#{q[prop]} " unless q[prop].nil?
+              q.delete(prop)
             end
 
             query += "#{q[:has_words]} " unless q[:has_words].nil?
             query += "-{#{q[:has_not_words]}}" unless q[:has_not_words].nil?
-            p "searching with this string #{query}"
-            all(q: query)
+            q.delete(:has_words)
+            q.delete(:has_not_words)
+
+            all(q.merge({q: query}))
           end
         end
       end