usman 0.2.11 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 2b2112f5abecf2b7e9a3f96c68f96f1d10cce382
-  data.tar.gz: 82b7fdf3aa9fda6dbff8b0af6fa7b4ae63959e4a
+  metadata.gz: da4ef048a641f75ac91c9ebcb697cd43c6f7fd9b
+  data.tar.gz: 53085820d81ef576b6b40b3a753d0d18fb40e039
 SHA512:
-  metadata.gz: 9bcb588f538bee5cd3d386c49454f4969d39de1962f30fe240894e1a3761854d8fa7143827dc9db734a5ee5fce1c720b765a4fb4514798071d602be3440aca15
-  data.tar.gz: 153befa09c258ef921cae756577f734d1380ed1759026ef3e30aec3e15b55a01dac73a42a4188ee0b9c4aa01f0aa5562a864818d99e1bf85c4cb092b8cd8fda8
+  metadata.gz: 1df87664bbe20cc17acf9814461719b98b4d74a2748faa9f3a0b9f0cc7cc20af53970c84043642310a87f797a1fb17c678d7738f2c018476c76212b3796a6aec
+  data.tar.gz: 1bb119d7386e8429368050aef3cf5c2463bc79a4b593546fc451ed110da28ee32f8d4ced1fb59dd990973d5c718198377cb4f08ac24c1dfae516061026be7a9e

data/app/controllers/usman/api/v1/docs_controller.rb

@@ -161,6 +161,90 @@ module Usman
           render 'kuppayam/api/docs/show'
         end
 
+        def profile
+          set_title("Profile API")
+          @request_type = "GET"
+          @end_point = "/api/v1/profile/base64_profile_picture"
+          @description = "This API will return the details of the profile requested including image urls."
+
+          @input_headers = {
+            "Content-Type" => { value: "application/json", description: "The MIME media type for JSON text is application/json. This is to make sure that a valid json is returned. The default encoding is UTF-8. " },
+            "Authorization" => { value: "Token token=\"87b01adbba90824b57add8cc06ad8738\"", description: "Put the API Token here. You shall get the API token after registering your device" }
+          }
+
+          @input_params = {}
+
+          @example_path = "usman/api/v1/docs/"
+          @examples = ["pos_case_1", "neg_case_1", "neg_case_2"]
+
+          set_nav("docs/profile")
+
+          render 'kuppayam/api/docs/show'
+        end
+
+        def base64_profile_picture
+          set_title("Upload Profile Picture API (base64)")
+          @request_type = "POST"
+          @end_point = "/api/v1/profile/base64_profile_picture"
+          @description = "This API will return the details of the profile requested including image urls."
+
+          @input_headers = {
+            "Content-Type" => { value: "application/json", description: "The MIME media type for JSON text is application/json. This is to make sure that a valid json is returned. The default encoding is UTF-8. " },
+            "Authorization" => { value: "Token token=\"87b01adbba90824b57add8cc06ad8738\"", description: "Put the API Token here. You shall get the API token after registering your device" }
+          }
+
+          @input_params = {}
+
+          @example_path = "usman/api/v1/docs/"
+          @examples = ["pos_case_1", "neg_case_1", "neg_case_2"]
+
+          set_nav("docs/base64_profile_picture")
+
+          render 'kuppayam/api/docs/show'
+        end
+
+        def profile_picture
+          set_title("Upload Profile Picture API")
+          @request_type = "POST"
+          @end_point = "/api/v1/profile/profile_picture"
+          @description = "This API will return the details of the profile requested including image urls."
+
+          @input_headers = {
+            "Content-Type" => { value: "application/json", description: "The MIME media type for JSON text is application/json. This is to make sure that a valid json is returned. The default encoding is UTF-8. " },
+            "Authorization" => { value: "Token token=\"87b01adbba90824b57add8cc06ad8738\"", description: "Put the API Token here. You shall get the API token after registering your device" }
+          }
+
+          @input_params = {}
+
+          @example_path = "usman/api/v1/docs/"
+          @examples = ["pos_case_1", "neg_case_1", "neg_case_2", "neg_case_3"]
+
+          set_nav("docs/profile_picture")
+
+          render 'kuppayam/api/docs/show'
+        end
+
+        def destroy_profile_picture
+          set_title("Delete Profile Picture API")
+          @request_type = "DELETE"
+          @end_point = "/api/v1/profile"
+          @description = "This API will return the details of the profile requested including image urls."
+
+          @input_headers = {
+            "Content-Type" => { value: "application/json", description: "The MIME media type for JSON text is application/json. This is to make sure that a valid json is returned. The default encoding is UTF-8. " },
+            "Authorization" => { value: "Token token=\"87b01adbba90824b57add8cc06ad8738\"", description: "Put the API Token here. You shall get the API token after registering your device" }
+          }
+
+          @input_params = {}
+
+          @example_path = "usman/api/v1/docs/"
+          @examples = ["pos_case_1", "neg_case_1", "neg_case_2", "neg_case_3"]
+
+          set_nav("docs/destroy_profile_picture")
+
+          render 'kuppayam/api/docs/show'
+        end
+
       end
     end
   end

data/app/controllers/usman/api/v1/profile_controller.rb

@@ -38,7 +38,7 @@ module Usman
                     heading: I18n.translate("api.profile.profile_created.heading"),
                     message: I18n.translate("api.profile.profile_created.message")
                   }
-                  @data = { user: @user }
+                  @data = ActiveModelSerializers::SerializableResource.new(@user, serializer: ProfileSerializer)
                 else
                   @success = false
                   @errors = {
@@ -91,7 +91,7 @@ module Usman
                     heading: I18n.translate("api.profile.profile_created.heading"),
                     message: I18n.translate("api.profile.profile_created.message")
                   }
-                  @data = { user: @user }
+                  @data = ActiveModelSerializers::SerializableResource.new(@user, serializer: ProfileSerializer)
                 else
                   @success = false
                   @errors = {
@@ -112,6 +112,31 @@ module Usman
           render_json_response(proc_code)
         end
 
+        def profile
+          proc_code = Proc.new do
+            if @current_registration
+              unless @current_user
+                @success = false
+                @errors = {
+                  heading: I18n.translate("api.profile.user_does_not_exists.heading"),
+                  message: I18n.translate("api.profile.user_does_not_exists.message")
+                }
+              else
+                @current_user
+                @success = true
+                @data = ActiveModelSerializers::SerializableResource.new(@current_user, serializer: ProfileSerializer)
+              end
+            else
+              @success = false
+              @errors = {
+                heading: I18n.translate("api.profile.registration_details_missing.heading"),
+                message: I18n.translate("api.profile.registration_details_missing.message")
+              }
+            end
+          end
+          render_json_response(proc_code)
+        end
+
         private
 
         def permitted_params

data/app/controllers/usman/api/v1/profile_picture_controller.rb

@@ -0,0 +1,178 @@
+module Usman
+	module Api
+		module V1
+			class ProfilePictureController < BaseController
+
+				include ImageUploaderHelper
+
+				def base64_profile_picture
+					proc_code = Proc.new do
+						if @current_registration
+              unless @current_user
+                @success = false
+                @errors = {
+                  heading: I18n.translate("api.profile.user_does_not_exists.heading"),
+                  message: I18n.translate("api.profile.user_does_not_exists.message")
+                }
+              else
+                user_image = @current_user.profile_picture || Image::ProfilePicture.new(imageable: @current_user)
+				      	begin
+					      	if params[:image] && !params[:image].blank?
+						      	user_image.image = image_params[:image_path]
+						      	user_image.valid?
+							      if user_image.errors.any?
+							      	@success = false
+											@errors = {
+												heading: I18n.translate("api.profile_picture.image_save_failed.heading"),
+												message: I18n.translate("api.profile_picture.image_save_failed.message"),
+												details: user_image.errors.full_messages
+											}
+							      else
+							      	@success = true
+							      	@alert = {
+				                heading: I18n.translate("api.profile_picture.image_saved.heading"),
+				                message: I18n.translate("api.profile_picture.image_saved.message")
+				              }
+											@data = ActiveModelSerializers::SerializableResource.new(user_image, serializer: ProfilePictureSerializer)
+							      	user_image.save
+							      end
+							    else
+							    	@success = false
+											@errors = {
+												heading: I18n.translate("api.profile_picture.image_save_failed.heading"),
+												message: I18n.translate("api.profile_picture.image_save_failed.message"),
+												details: "Image can't be blank"
+											}
+							    end
+					    	rescue Exception => e
+					    		@success = false
+									@errors = {
+										heading: I18n.translate("api.profile_picture.image_save_failed.heading"),
+										message: I18n.translate("api.profile_picture.image_save_failed.message"),
+										details: "Unable to parse the base64 image data"
+									}
+					    	end
+              end
+            else
+              @success = false
+              @errors = {
+                heading: I18n.translate("api.profile.registration_details_missing.heading"),
+                message: I18n.translate("api.profile.registration_details_missing.message")
+              }
+            end
+					end
+					render_json_response(proc_code)
+				end
+
+				def profile_picture
+					proc_code = Proc.new do
+						if @current_registration
+              unless @current_user
+                @success = false
+                @errors = {
+                  heading: I18n.translate("api.profile.user_does_not_exists.heading"),
+                  message: I18n.translate("api.profile.user_does_not_exists.message")
+                }
+              else
+                user_image = @current_user.profile_picture || Image::ProfilePicture.new(imageable: @current_user)
+					      begin
+					      	if params[:image] && !params[:image].blank?
+						      	user_image.image = params[:image]
+						      	user_image.valid?
+							      if user_image.errors.any?
+							      	@success = false
+											@errors = {
+												heading: I18n.translate("api.profile_picture.image_save_failed.heading"),
+												message: I18n.translate("api.profile_picture.image_save_failed.message"),
+												details: user_image.errors.full_messages
+											}
+							      else
+							      	@success = true
+							      	@alert = {
+				                heading: I18n.translate("api.profile_picture.image_saved.heading"),
+				                message: I18n.translate("api.profile_picture.image_saved.message")
+				              }
+											@data = ActiveModelSerializers::SerializableResource.new(user_image, serializer: ProfilePictureSerializer)
+							      	user_image.save
+							      end
+							    else
+							    	@success = false
+											@errors = {
+												heading: I18n.translate("api.profile_picture.image_save_failed.heading"),
+												message: I18n.translate("api.profile_picture.image_save_failed.message"),
+												details: "Image can't be blank"
+											}
+							    end
+					    	rescue Exception => e
+					    		@success = false
+									@errors = {
+										heading: I18n.translate("api.profile_picture.image_save_failed.heading"),
+										message: I18n.translate("api.profile_picture.image_save_failed.message"),
+										details: "Unable to parse the base64 image data"
+									}
+					    	end
+              end
+            else
+              @success = false
+              @errors = {
+                heading: I18n.translate("api.profile.registration_details_missing.heading"),
+                message: I18n.translate("api.profile.registration_details_missing.message")
+              }
+            end
+					end
+					render_json_response(proc_code)
+				end
+
+				def destroy_profile_picture
+					proc_code = Proc.new do
+						if @current_registration
+              unless @current_user
+                @success = false
+                @errors = {
+                  heading: I18n.translate("api.profile.user_does_not_exists.heading"),
+                  message: I18n.translate("api.profile.user_does_not_exists.message")
+                }
+              else
+                user_image = @current_user.profile_picture
+                unless user_image
+	                @success = false
+	                @errors = {
+	                  heading: I18n.translate("api.profile_picture.profile_picture_does_not_exists.heading"),
+                  	message: I18n.translate("api.profile_picture.profile_picture_does_not_exists.message")
+	                }
+	              else
+						      begin
+						      	@success = true
+						      	@alert = {
+			                heading: I18n.translate("api.profile_picture.image_deleted.heading"),
+			                message: I18n.translate("api.profile_picture.image_deleted.message")
+			              }
+										user_image.destroy
+						    	rescue Exception => e
+						    		@success = false
+										@errors = {
+											heading: I18n.translate("api.profile_picture.image_delete_failed.heading"),
+											message: I18n.translate("api.profile_picture.image_delete_failed.message"),
+											details: "Unable to parse the base64 image data"
+										}
+						    	end
+						    end
+              end
+            else
+              @success = false
+              @errors = {
+                heading: I18n.translate("api.profile.registration_details_missing.heading"),
+                message: I18n.translate("api.profile.registration_details_missing.message")
+              }
+            end
+					end
+					render_json_response(proc_code)
+				end
+
+				private
+				
+			end
+		end
+	end
+end
+

data/app/serializers/profile_picture_serializer.rb

@@ -0,0 +1,19 @@
+class ProfilePictureSerializer < ActiveModel::Serializer
+  include NullAttributeReplacer
+  
+  attributes :id, :created_at, :profile_id
+  attributes :image_large_path, :image_small_path
+  	
+  def profile_id
+  	object.imageable_id
+  end
+
+  def image_large_path
+    object.image_url :large
+  end
+
+  def image_small_path
+    object.image_url :small
+  end
+  
+end

data/app/serializers/profile_serializer.rb

@@ -0,0 +1,6 @@
+class ProfileSerializer < ActiveModel::Serializer
+	include NullAttributeReplacer
+  attributes :id, :name, :gender, :date_of_birth, :username, :email, :phone
+
+  has_one :profile_picture, class_name: "Image::ProfilePicture", serializer: ProfilePictureSerializer
+end

data/app/uploaders/feature_image_uploader.rb

@@ -1,4 +1,5 @@
 class FeatureImageUploader < ImageUploader
+	
 	def store_dir
     "uploads/feature_images/#{model.id}"
   end

data/app/uploaders/profile_picture_uploader.rb

@@ -11,5 +11,9 @@ class ProfilePictureUploader < ImageUploader
   version :small do
     process :resize_to_fill => [100, 100]
   end
+
+  def default_url
+    'default.png'
+  end
   
 end

data/app/views/kuppayam/api/docs/_navigation.html.erb

@@ -35,6 +35,30 @@
       <span class="hidden-xs">Update Profile</span>
     </a>
   </li>
+  <li class="<%= nav_active?('docs/profile') ? 'active' : ''  %>">
+    <a href="/docs/api/v1/profile">
+      <i class="fa-globe visible-xs"></i>
+      <span class="hidden-xs">Profile</span>
+    </a>
+  </li>
+  <li class="<%= nav_active?('docs/base64_profile_picture') ? 'active' : ''  %>">
+    <a href="/docs/api/v1/base64_profile_picture">
+      <i class="fa-globe visible-xs"></i>
+      <span class="hidden-xs">Upload Profile Picture (Base64)</span>
+    </a>
+  </li>
+  <li class="<%= nav_active?('docs/profile_picture') ? 'active' : ''  %>">
+    <a href="/docs/api/v1/profile_picture">
+      <i class="fa-globe visible-xs"></i>
+      <span class="hidden-xs">Upload Profile Picture</span>
+    </a>
+  </li>
+  <li class="<%= nav_active?('docs/destroy_profile_picture') ? 'active' : ''  %>">
+    <a href="/docs/api/v1/destroy_profile_picture">
+      <i class="fa-globe visible-xs"></i>
+      <span class="hidden-xs">Delete Profile Picture</span>
+    </a>
+  </li>
 </ul>
 
 <style type="text/css">

data/app/views/usman/api/v1/docs/base64_profile_picture/_neg_case_1.html.erb

@@ -0,0 +1,27 @@
+<%
+
+api_title = "Negative Case - 1 - should set proper errors if no api token"
+
+api_input = <<-eos
+{}
+eos
+
+api_output = <<-eos
+{
+  "success": false,
+  "errors": {
+    "heading": "Invalid API Token",
+    "message": "Use the API Token you have received after accepting the terms and agreement"
+  }
+}
+eos
+
+%>
+
+<%= render partial: "kuppayam/api/docs/example", locals: {
+                                        negative_case: true,
+                                        example_id: "neg_case_1",
+                                        api_title: api_title,
+                                        api_input: api_input,
+                                        api_output: api_output 
+                                      } %>

data/app/views/usman/api/v1/docs/base64_profile_picture/_neg_case_2.html.erb

@@ -0,0 +1,28 @@
+<%
+
+api_title = "Negative Case - 1 - should respond with proper errors for invalid arguments"
+
+api_input = <<-eos
+{}
+eos
+
+api_output = <<-eos
+{
+  "success": false,
+  "errors": {
+    "heading": "Saving user/profile image was failed",
+    "message": "Make sure that the arguments are passed according to the API documentation. Please check the API Documentation for more details.",
+    "details": "Image can't be blank"
+  }
+}
+eos
+
+%>
+
+<%= render partial: "kuppayam/api/docs/example", locals: {
+                                        negative_case: true,
+                                        example_id: "neg_case_2",
+                                        api_title: api_title,
+                                        api_input: api_input,
+                                        api_output: api_output 
+                                      } %>