edmodo-api 0.0.3 → 0.1.0

data/README.markdown

@@ -43,11 +43,10 @@ You're welcome to fork this project and send pull requests. Just remember to inc
 TO DO
 ---------
 
-- Finish implementation of all the methods
+- Find a way to pass a string as query params to a POST requests when using HTTParty to finish implementing the methods that are not supported yet
 - Thinking about adding all the requests name into an array and overriding the Ruby method_missing method to DRY up the client code
-- Adding tests for every method
 
-Edmodo methods that will be supported
+Supported Edmodo API methods
 ---------
 
 - launchRequests
@@ -67,8 +66,6 @@ Edmodo methods that will be supported
 - parents
 - children
 - profiles
-- userPost
-- turnInAssignment
 - registerBadge
 - updateBadge
 - awardBadge
@@ -78,4 +75,8 @@ Edmodo methods that will be supported
 - newEvent
 - addToLibrary
 - setNotification
+- UserPost
+- turnInAssignment
+- NewEvent
+- AddToLibrary
 

data/lib/edmodo-api/normalizer.rb

@@ -0,0 +1,20 @@
+module Edmodo
+	module API
+		module Normalizer
+			EDMODO_JSON_NORMALIZER = Proc.new { |query|
+					query.map do |key, v|
+						value = String.new
+
+						if v.is_a?(Array)
+							value = URI.encode(v.to_json, Regexp.new("[^#{URI::PATTERN::UNRESERVED}]"))
+						else
+							value = URI.encode(v.to_s, Regexp.new("[^#{URI::PATTERN::UNRESERVED}]"))
+						end
+
+						"#{key}=#{value}"
+					end.join('&')
+				}
+		end
+	end
+end
+

data/lib/edmodo-api/request.rb

@@ -14,7 +14,7 @@ module Edmodo
           when :get
             self.class.get(uri, query: query )
           when :post
-            self.class.post(uri, query: query)
+            self.class.post(uri, query: query, :query_string_normalizer => Edmodo::API::Normalizer::EDMODO_JSON_NORMALIZER)
           else
             raise EdmodoApiError.new "EdmodoAPI Error: Request Method error."
           end

data/lib/edmodo-api/version.rb

@@ -2,6 +2,6 @@
 
 module Edmodo
 	module API
-		VERSION = "0.0.3"
+		VERSION = "0.1.0"
 	end
 end

data/lib/edmodo-api.rb

@@ -2,5 +2,6 @@
 
 require 'edmodo-api/version'
 require 'edmodo-api/config'
+require 'edmodo-api/normalizer'
 require 'edmodo-api/request'
 require 'edmodo-api/client'

data/spec/edmodo-api_spec.rb

@@ -59,6 +59,16 @@ describe Edmodo::API::Client do
     end
   end
 
+  describe 'GET Requests in Production' do
+    it 'should get the correct hash back from the launchRequest request when environment is production' do
+      client = Edmodo::API::Client.new(@api_key, :mode => :production)
+
+      response = client.launch_requests("5c18c7")
+
+      response.should == {"user_type"=>"TEACHER", "user_token"=>"b020c42d1", "first_name"=>"Bob", "last_name"=>"Smith", "avatar_url"=>"http://edmodoimages.s3.amazonaws.com/default_avatar.png", "thumb_url"=>"http://edmodoimages.s3.amazonaws.com/default_avatar_t.png", "groups"=>[{"group_id"=>379557, "is_owner"=>1}, {"group_id"=>379562, "is_owner"=>1}]}
+    end
+  end
+
   describe 'GET Requests' do
     before do
       @client = Edmodo::API::Client.new(@api_key)
@@ -194,20 +204,16 @@ describe Edmodo::API::Client do
 
     it 'should get the correct response back from the userPost request' do
       
-      pending("This call has to be fixed")
-
-      response = @client.user_post("b020c42d1", "This is my test message", {:user_token => "b020c42d1", :user_token => "693d5c765", :group_id => 379557}, [{:type => "link", :title => "A link", :url => "http://www.edmodo.com"}, {:type => "embed", :title => "An embed with an optional thumbnail url", :thumb_url => "http://images.edmodo.com/images/logos/edmodo_134x43.png"}])
+      response = @client.user_post("b020c42d1", "This is my test message", [{:user_token => "b020c42d1"}, {:user_token => "693d5c765"}, {:group_id => 379557}], [{:type => "link", :title => "A link", :url => "http://www.edmodo.com"}, {:type => "embed", :title => "An embed with an optional thumbnail url", :thumb_url => "http://images.edmodo.com/images/logos/edmodo_134x43.png"}])
 
-      response.should == {:status => "success"}
+      response.should == {"status" => "success"}
     end
 
     it 'should get the correct response back from the turnInAssignment request' do
       
-      pending("This call has to be fixed")
-
-      response = @client.turn_in_assignment("83a8e614d", 4738052, "Here is my assignment submission", {:type => "link", :title => "A link", :url => "http://www.edmodo.com"})
+      response = @client.turn_in_assignment("83a8e614d", 4738052, "Here is my assignment submission", [{:type => "link", :title => "A link", :url => "http://www.edmodo.com"}])
 
-      response.should == {:status => "success"}
+      response.should == {"status" => "success"}
     end
 
     it 'should get the correct hash response from the registerBadge request' do
@@ -248,9 +254,8 @@ describe Edmodo::API::Client do
 
     it 'should get the correct hash response from the newEvent request' do
 
-      pending("This call has to be fixed")
-
       recipients = [{:user_token => "b020c42d1"},{:group_id => 379557}]
+
       response = @client.new_event("b020c42d1", "Pizza party tomorrow", "2011-12-07", "2011-12-07", recipients)
       
       response.should == {"event_id" => 621119}
@@ -258,8 +263,6 @@ describe Edmodo::API::Client do
 
     it 'should get the correct hash response from the addToLibrary request' do
 
-      pending("This call has to be fixed")
-
       resource = {:type => "link", :title => "A link", :url => "http://www.edmodo.com", :thumb_url => "http://images.edmodo.com/images/logos/edmodo_134x43.png" }
       response = @client.add_to_library("b020c42d1", true, resource)
       

data/spec/requests/get_requests.rb

@@ -3,6 +3,29 @@ uri = "#{Edmodo::API::Config.endpoints[:sandbox]}/launchRequests.json?api_key=#{
 
 FakeWeb.register_uri(:get, uri, :body => '{"error":{"code":3000,"message":"Unauthorized API request"}}', :status => ["401", "Authorization Required"])
 
+# launchRequest request uri on production
+uri = "#{Edmodo::API::Config.endpoints[:production]}/launchRequests.json?api_key=#{@api_key}&launch_key=5c18c7"
+
+FakeWeb.register_uri(:get, uri,
+					 :body => '	{
+								    "user_type":"TEACHER",
+								    "user_token":"b020c42d1",
+								    "first_name":"Bob",
+								    "last_name":"Smith",
+								    "avatar_url":"http://edmodoimages.s3.amazonaws.com/default_avatar.png",
+								    "thumb_url":"http://edmodoimages.s3.amazonaws.com/default_avatar_t.png",
+								    "groups":[
+								        {
+								            "group_id":379557,
+								            "is_owner":1
+								        },
+								        {
+								            "group_id":379562,
+								            "is_owner":1
+								        }
+								    ]
+								}')
+
 # launchRequest request uri
 uri = "#{Edmodo::API::Config.endpoints[:sandbox]}/launchRequests.json?api_key=#{@api_key}&launch_key=5c18c7"
 

data/spec/requests/post_requests.rb

@@ -1,17 +1,12 @@
 # -- POST REQUESTS ---
 
 # userPost request uri
-recipients = "[{'user_token':'b020c42d1'},{'user_token':'693d5c765'},{'group_id':379557}]"
-attachments = "[{'type':'link','title':'A link','url':'http://www.edmodo.com'},{'type':'embed','title':'An embed with an optional thumbnail url','thumb_url':'http://images.edmodo.com/images/logos/edmodo_134x43.png'}]"
-
-uri = URI.encode "#{Edmodo::API::Config.endpoints[:sandbox]}/userPost?api_key=#{@api_key}&user_token=b020c42d1&content=This%20is%20my%20test%20message&recipients=#{recipients}&attachments=#{attachments}"
+uri = "https://appsapi.edmodobox.com/v1/userPost?api_key=1234567890abcdefghijklmn&user_token=b020c42d1&content=This%20is%20my%20test%20message&recipients=%5B%7B%22user_token%22%3A%22b020c42d1%22%7D%2C%7B%22user_token%22%3A%22693d5c765%22%7D%2C%7B%22group_id%22%3A379557%7D%5D&attachments=%5B%7B%22type%22%3A%22link%22%2C%22title%22%3A%22A%20link%22%2C%22url%22%3A%22http%3A%2F%2Fwww.edmodo.com%22%7D%2C%7B%22type%22%3A%22embed%22%2C%22title%22%3A%22An%20embed%20with%20an%20optional%20thumbnail%20url%22%2C%22thumb_url%22%3A%22http%3A%2F%2Fimages.edmodo.com%2Fimages%2Flogos%2Fedmodo_134x43.png%22%7D%5D"
 
 FakeWeb.register_uri(:post, uri, :body => '{"status":"success"}')
 
 # turnInAssignment request uri
-attachments = "[{'type':'link','title':'A link','url':'http://www.edmodo.com'}]"
-
-uri = URI.encode "#{Edmodo::API::Config.endpoints[:sandbox]}/turnInAssignment?api_key=#{@api_key}&user_token=b020c42d1&assignment_id=4738052&content=Here%20is%20my%20assignment%20submission&attachments=#{attachments}"
+uri = "#{Edmodo::API::Config.endpoints[:sandbox]}/turnInAssignment?api_key=#{@api_key}&user_token=83a8e614d&assignment_id=4738052&content=Here%20is%20my%20assignment%20submission&attachments=%5B%7B%22type%22%3A%22link%22%2C%22title%22%3A%22A%20link%22%2C%22url%22%3A%22http%3A%2F%2Fwww.edmodo.com%22%7D%5D"
 
 FakeWeb.register_uri(:post, uri, :body => '{"status":"success"}')
 
@@ -46,16 +41,13 @@ uri = "#{Edmodo::API::Config.endpoints[:sandbox]}/setGrade?api_key=#{@api_key}&g
 FakeWeb.register_uri(:post, uri, :body => '{"user_token":"83a8e614d", "score":"3", "total":"10"}')
 
 # newEvent request uri
-receipients = URI.encode '[{"user_token":"b020c42d1"},{"group_id":379557}]'
-
-uri = "#{Edmodo::API::Config.endpoints[:sandbox]}/newEvent?api_key=#{@api_key}&user_token=b020c42d1&description=Pizza+party+tomorrow&start_date=2011-12-07&end_date=2011-12-07&recipients=#{receipients}"
+uri = "#{Edmodo::API::Config.endpoints[:sandbox]}/newEvent?api_key=#{@api_key}&user_token=b020c42d1&description=Pizza%20party%20tomorrow&start_date=2011-12-07&end_date=2011-12-07&recipients=%5B%7B%22user_token%22%3A%22b020c42d1%22%7D%2C%7B%22group_id%22%3A379557%7D%5D"
 
 FakeWeb.register_uri(:post, uri, :body => '{"event_id":621119}')
 
 # addToLibrary request uri
-resource = URI.encode '{"type":"link","title":"A link","url":"http://www.edmodo.com","thumb_url":"http://images.edmodo.com/images/logos/edmodo_134x43.png"}'
 
-uri = "#{Edmodo::API::Config.endpoints[:sandbox]}/addToLibrary?api_key=#{@api_key}&user_token=b020c42d1&publisher_owned=1&resource=#{resource}"
+uri = "#{Edmodo::API::Config.endpoints[:sandbox]}/addToLibrary?api_key=#{@api_key}&user_token=b020c42d1&publisher_owned=1&resource=%7B%3Atype%3D%3E%22link%22%2C%20%3Atitle%3D%3E%22A%20link%22%2C%20%3Aurl%3D%3E%22http%3A%2F%2Fwww.edmodo.com%22%2C%20%3Athumb_url%3D%3E%22http%3A%2F%2Fimages.edmodo.com%2Fimages%2Flogos%2Fedmodo_134x43.png%22%7D"
 
 FakeWeb.register_uri(:post, uri, :body => '{"library_item_id":"456"}')
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: edmodo-api
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 0.1.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-01-05 00:00:00.000000000 Z
+date: 2013-01-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: httparty
@@ -125,6 +125,7 @@ files:
 - lib/edmodo-api.rb
 - lib/edmodo-api/client.rb
 - lib/edmodo-api/config.rb
+- lib/edmodo-api/normalizer.rb
 - lib/edmodo-api/request.rb
 - lib/edmodo-api/version.rb
 - spec/edmodo-api_spec.rb