Code Crumbs Archives - caskiSPACE

AWS: Step Functions

saborot — Wed, 17 May 2023 02:41:35 +0000

How to Add Your Step Functions Inside Cloud Formation

I recently had to create a series of step functions for a project I am working on. The beauty of using step function is you get to work on it visually; from adding of functions, states, inputs and outputs up to real-time running and debugging.

It is awesome! However, after the wow factor, one thing that came to mind was “How am I going to get this inside a repository so it can be versioned?”. Turns out, I can actually add all of it inside a CloudFormation! Meaning in my application, I can create a YAML file, add it in there and it will generate the State Machine which has all of my step functions inside.

First I needed a policy so I can perform Step Function actions from within my application.


  Resources:
    MyAppRole:
      Type: AWS::IAM::Role
      Properties:
        AssumeRolePolicyDocument:
          Version: '2012-10-17'
          Statement:
            - Effect: Allow
              Principal:
                Service:
                  - states.amazonaws.com
              Action:
                - sts:AssumeRole
          - PolicyName: StepFunctions
            PolicyDocument:
              Version: '2012-10-17'
              Statement:
              - Effect: Allow
                Action:
                  - states:*
                Resource: '*'

Then I added the following inside my template.yaml file under Resources section:


  Resources:
    MyStateMachine:
      Type: AWS::StepFunctions::StateMachine
      Properties:
        StateMachineName: MyStateMachineName
        RoleArn: !GetAtt MyAppRole.Arn
        DefinitionString:
          Fn::Sub: |
            {
            ... STEP FUNCTION DEFINITION HERE
            }

The post AWS: Step Functions appeared first on caskiSPACE.

Call ChromeData in NodeJS and PHP

saborot — Sat, 06 Nov 2021 07:34:52 +0000

In this code crumb, we will call ChromeData in NodeJS and PHP.

We will call the “describeVehicle” method of ChromeData ADS(Automotive Description Service). The “describeVehicle” method accepts a vehicle’s VIN, searches its database for a match then responds with information for that vehicle.

ChromeData uses WSDL and one way for us to make use of its services is to connect to it by passing our credentials along with our request parameters using SOAP(Simple Object Access Protocol).

The process is pretty much the same between languages, however there is one key difference when passing credentials using NodeJS “node-soap” module. It seems that in NodeJS, we need to explicitly tell the module to treat the credentials(number, secret, country, language) as attributes of the AccountInfo XML element instead of children. This is something we don’t have to explicitly define when passing our request parameters to SoapClient in PHP.

Using PHP

Step 1. Prepare Request Parameters

Prepare Request Parameters

$url = 'http://services.chromedata.com/Description/7c?wsdl';
$request_params = [
    'accountInfo' => [
        'number'=>'12345',
        'secret'=>'A12B345C67890123',
        'country'=>'US',
        'language' =>'en'    
    ],
    'vin' => '5GAKVCED2CJ310674',
];

Step 2. Create a SOAP Client

References: SoapClient

try {
    $client = new SoapClient($url);
} catch (SoapFault $e) {
    $msg = 'chrome_ads_get_client -- Could not get client. ' . $e->getMessage();
}

Step 3. Call the ChromeData ADS "describeVehicle" Method

Call the ChromeData ADS “describeVehicle” Method

try {
    $response = $client->__soapCall('describeVehicle', [$request_params]);
} catch (Exception $e) {
    $msg = 'chrome_ads_describe_vehicle -- Could not get data. ' . $e->getMessage();
}

Using Node JS

Step 1. Prepare Request Parameters

Prepare Request Parameters

NOTE: The “AccountInfo” parameter here is written differently than how we are doing it on PHP. In the code below, we are explicitly defining that “number”, “secret”, “country” and “language” are attributes of “AccountInfo”. If we do not do it this way, the resulting request XML would treat those as children of AccountInfo rather than attributes resulting in an “Unable to authenticate account –**UNKNOWN**–“ error.

const url = 'http://services.chromedata.com/Description/7c?wsdl';
const requestParams = {
    accountInfo: {
        attributes: {
            number: '12345',
            secret: 'A12B345C67890123',
            country: 'US',
            language: 'en'
        }
    },
    vin: '5GAKVCED2CJ310674,
};

Step 2. Install Required Modules

Install Required Modules

References: vpulim/node-soap, @types/Sax

In your command line interface, install “soap” and it’s build dependency “@types/sax”

npm install soap
npm install --save-dev @types/sax

Step 3. Create a SOAP Client

Create a SOAP Client

const soap = require('soap');
const soapClient = await soap.createClientAsync(url);

Step 4. Call the ChromeData ADS "describeVehicle" Method

Call the ChromeData ADS “describeVehicle” Method

const results = await soapClient['describeVehicleAsync']([requestParams]);

The post Call ChromeData in NodeJS and PHP appeared first on caskiSPACE.

Upload Ads.txt to Bitnami Web Server

saborot — Tue, 02 Nov 2021 05:02:56 +0000

This seems easy but I spent some time googling it on the internet and did not find a straight answer. I had to move my WordPress site to an AWS LightSail due to some technical issue with my previous web host and I didn’t know where to put my Ads.txt.

To cut things short, AWS LightSail’s Linux + WordPress uses Bitnami and the root directory for its web server is on /OPT/BITNAMI/WORDPRESS.

Just drop your Ads.txt in that directory and you should be good. Once you have uploaded your Ads.txt, you should be able to access it using a browser by going to www.{yourdomain.com}/ads.txt.

If you are using a different setup or prefer not to deal with technicalities, you can use a WordPress plugin. Login to your WordPress site and add the ‘File Manager‘ plugin. This plugin will show you the root directory of your WordPress site and from there you can upload to it directly.

The post Upload Ads.txt to Bitnami Web Server appeared first on caskiSPACE.

Query Database Using WordPress REST

saborot — Sat, 05 Dec 2020 16:22:52 +0000

This code crumb will query a WordPress database using WP REST. It tackles all the basic steps to interact and get data from the WordPress database in three different ways; directly from the browser using a URL, calling from a PHP function or by a user-driven event from the front-end interface using Javascript which will then call a PHP function which in turn will query the database and return the result.

Step 1. Register an Endpoint

Register an Endpoint

Create a function which will contain the route registration.
Define the endpoint’s route using ‘register_rest_route’.
Add the function to the ‘rest_api_init’ hook

function register_route() {

   register_rest_route('get-user/v1', '/first/(?P.+)/last/(?P.+)', [
      'methods' => 'GET',
      'callback' => 'get_user_callback',
      'permission_callback' => '__return_true',
   ]);

}

add_action('rest_api_init', 'register_route');

Step 2. Create a Callback Function to Query the Database

Step 2. Create the Callback Function that Will Query the Database

Create the callback function for the endpoint
Get reference to the WordPress Database Access object (wpdb).
Get the parameters passed to the endpoint.
Prepare the database query using wpdb->prepare. Use ‘%s’ for string, ‘%d’ for integer and ‘%f’ for float values.
Query the database and get results. Use wpdb->get_results for SELECT statements and wpdb->query for DELETE/UPDATE.
Return the data in a WP_REST_Response object.

function get_user_callback(WP_REST_Request $request) {

   global $wpdb;

   $first_name = urldecode($request->get_param( 'first' ));
   $last_name = urldecode($request->get_param( 'last' ));

   $query = "SELECT * FROM 'users_table' WHERE 'first_name' = %s AND 'last_name' = %s";
   $prepared_query = $wpdb->prepare($query, $first_name, $last_name);

   $data = $wpdb->get_results($prepared_query);

   return new WP_REST_Response($data);

}

Step 3.a Call Directly From a Browser using a URL

Call Call Directly From a Browser using a URL

Call directly from a browser by prefixing the Route with /wp-json/.

With parameters: (first name = ‘Gieon Felice’ and last name = ‘Aborot’)

https://yourdomain.com/wp-json/get-user/v1/first/Gieon Felice/last/Aborot

Step 3.b Call the Endpoint Using PHP

Call the Endpoint From PHP

Use wp_remote_get to request data from the endpoint.
Handle errors and unsuccessful requests using is_wp_error and WP_Error.
Finally use wp_remote_retrieve_body to get the response.

function call_from_php() {

   $response = wp_remote_get(
      "https://yourdomain.com/wp-json/get-user/v1/first/Gieon Felice/last/Aborot", [
         'sslverify' => false,
      ]
   );

   if ( is_wp_error( $response ) ) {
      return new WP_Error( 'call_from_php unsuccessful', $response->get_error_message() );
   }

   return wp_remote_retrieve_body($response);

}

Step 3.c Trigger the Call to the Endpoint From the Front-end Using Javascript

Trigger the Call to the Endpoint From the Front-end Using Javascript

In PHP, declare the ajax_url object using wp_localize_script. This is needed to call the PHP function from JS using the AJAX request.
Add wordpress hooks to make a connection between the AJAX request action and the name of php function to call. ‘wp_ajax_nopriv’ fires ONLY if the user is not logged-in while ‘wp_ajax’ fires ONLY if the user is logged-in.
Create a PHP function which will be called from Javascript and in turn will call the Endpoint.
Finally in Javascript, create the function that will make an AJAX request to call the PHP function.

wp_localize_script(
   'id_on_the_enqueued_script_that_will_use_it',
   'my_ajax_object',
   [ 'ajax_url' => admin_url( 'admin-ajax.php' ) ]
);

add_action('wp_ajax_nopriv_call_from_js_to_php', 'call_from_php');
add_action('wp_ajax_call_from_js_to_php', 'call_from_php');

function call_from_php() {

   $first_name = $_GET['first_name'];
   $last_name = $_GET['last_name'];

   $response = wp_remote_get(
      "https://yourdomain.com/wp-json/get-user/v1/first/$first_name/last/$last_name", [
         'sslverify' => false,
      ]
   );

   if ( is_wp_error( $response ) ) {
      return new WP_Error( 'call_from_php unsuccessful', $response->get_error_message() );
   }

   wp_send_json(wp_remote_retrieve_body($response), 200);
}

function call_from_js() {
   jQuery.ajax(my_ajax_object.ajax_url, {
      type: 'GET',
      data: {
            action: 'call_from_js_to_php',
            first_name: 'Gieon Felice',
            last_name: 'Aborot',
      },
   }).done(response => {
      const parsedResults = JSON.parse(response);
      // Do something with the result
   }).fail(error => {
      // Do something when an unsuccessful
   });
}

The post Query Database Using WordPress REST appeared first on caskiSPACE.